移動

• リクエスト
• レスポンス

チャネルのオーダラの拡張属性の更新

patch

/console/admin/api/v2/channels/{channelName}/orderingSettings

チャネルのオーダラの拡張属性を更新します。

リクエスト

サポートされるメディア・タイプ

• application/json

パス・パラメータ

• channelName(必須): string
  指定したチャネル名

本文()

更新に使用するこのチャネルの新しいオーダラ属性。'batchTimeout'は、'2s'などの文字列で指定することに注意してください。

ルート・スキーマ: schema

型: object

ソースの表示

• absoluteMessageBytes: number
  デフォルト値: 98

  例: 98
• batchTimeout: string
  デフォルト値: 2s

  例: 2s
• maxMessageCount: number
  デフォルト値: 10

  例: 10
• preferredMessageBytes: number
  デフォルト値: 512

  例: 512

{
    "type":"object",
    "properties":{
        "absoluteMessageBytes":{
            "type":"number",
            "default":"98",
            "example":"98"
        },
        "maxMessageCount":{
            "type":"number",
            "default":"10",
            "example":"10"
        },
        "preferredMessageBytes":{
            "type":"number",
            "default":"512",
            "example":"512"
        },
        "batchTimeout":{
            "type":"string",
            "default":"2s",
            "example":"2s"
        }
    }
}

先頭に戻る

レスポンス

サポートされるメディア・タイプ

• application/json

200レスポンス

成功

本文()

ルート・スキーマ: 200successModels

型: object

ソースの表示

• key: string
• value: string

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    },
    "example":{
        "status":"success"
    }
}

例:

{
    "status":"success"
}

400レスポンス

無効な引数

401レスポンス

未認可

403レスポンス

禁止されています

404レスポンス

リソースが見つかりません

500レスポンス

内部サーバー・エラー

本文()

ルート・スキーマ: 500errorModels

型: object

ソースの表示

• key: string
• value: string

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

先頭に戻る