エンコードオプションテンプレートリストの照会

Prev Next

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

エンコードオプションテンプレートリストを照会します。テンプレートを設定すると、映像コンテンツタイプに適した組み合わせのエンコードプリセットを使用できます。

リクエスト

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

メソッド URI
GET /api/v2/encoding-option/template

リクエストヘッダ

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

リクエスト例

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

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

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
content Array - テンプレートリスト: content

content

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

フィールド タイプ 必須の有無 説明
id Integer - テンプレート ID
name String - テンプレート名
  • Practical content | Business content | Ultra-high-definition content
    • Practical content: 経済的なコンテンツ
    • Business content: ビジネスコンテンツ
    • Ultra-high-definition content: 超高画質コンテンツ
encodingOptionIds Array - テンプレートに含まれているエンコードオプション IDリスト

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

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

レスポンス例

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

{
    "content": [
        {
            "id": 1,
            "name": "Practical content",
            "encodingOptionIds": [
                1,
                2,
                3
            ]
        },
        {
            "id": 2,
            "name": "Business content",
            "encodingOptionIds": [
                2,
                3,
                4
            ]
        },
        {
            "id": 3,
            "name": "Ultra-high-definition content",
            "encodingOptionIds": [
                10,
                11,
                12,
                13
            ]
        }
    ]
}