この API は、指定された PolarClaw チャネルを無効化します。
操作説明
概要
DisablePolarClawChannel API を呼び出して、特定のアプリケーション向けの PolarClaw チャネルを無効化します。この操作を実行する前に、対象のチャネル ID とアプリケーション ID をご確認ください。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
POST HTTP/1.1
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ApplicationId |
string |
必須 |
アプリケーション ID。 |
pa-************** |
| ChannelId |
string |
必須 |
チャネルの一意な ID。 |
feishu |
| Restart |
boolean |
任意 |
チャネル無効化後にゲートウェイを再起動するかどうかを指定します。デフォルト値は true です。 |
true |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答スキーマ。 |
||
| RequestId |
string |
リクエスト ID。 |
2281C6C9-CBAB-1AFD-8400-670750CF6025_2212 |
| Message |
string |
応答メッセージ。 |
successful |
| Code |
integer |
応答状態コード。 |
200 |
| ApplicationId |
string |
アプリケーション ID。 |
pa-************** |
| Ok |
boolean |
操作が成功したかどうかを示します。 |
true |
| ChannelId |
string |
無効化されたチャネルの ID。 |
feishu |
| Restarted |
boolean |
ゲートウェイが再起動されたかどうかを示します。 |
true |
例
成功レスポンス
JSONJSON
{
"RequestId": "2281C6C9-CBAB-1AFD-8400-670750CF6025_2212",
"Message": "successful",
"Code": 200,
"ApplicationId": "pa-**************",
"Ok": true,
"ChannelId": "feishu",
"Restarted": true
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。