ウェイティングルームのバイパスルールを照会します。
操作説明
この API を使用すると、ユーザーは特定のサイトに関連付けられたウェイティングルームのバイパスルールのリストを照会できます。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
esa:ListWaitingRoomRules |
list |
*Site
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| SiteId |
integer |
必須 |
サイト ID。ListSites インターフェイスを呼び出すことで取得できます。 |
123456**** |
| WaitingRoomId |
string |
必須 |
バイパスするウェイティングルームの ID。ListWaitingRooms インターフェイスを呼び出すことで取得できます。 |
6a51d5bc6460887abd129**** |
| WaitingRoomRuleId |
integer |
任意 |
更新するウェイティングルームのバイパスルールの ID。ListWaitingRoomRules インターフェイスを呼び出すことで取得できます。 |
37286782688**** |
| RuleName |
string |
任意 |
ルール名。任意。ウェイティングルームのバイパスルール名でクエリを実行するために使用されます。 |
test |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
クエリの応答結果。 |
||
| RequestId |
string |
リクエスト ID。呼び出しステータスを追跡するために使用されます。 |
15C66C7B-671A-4297-9187-2C4477247A123425345 |
| WaitingRoomRules |
array<object> |
ウェイティングルームのバイパスルールのリスト。 |
|
|
object |
ウェイティングルームのバイパスルールの詳細。 |
||
| WaitingRoomRuleId |
integer |
ルール ID。 |
37286782688**** |
| RuleName |
string |
ルール名。グローバル構成を追加する場合、このパラメーターを設定する必要はありません。 |
ip |
| RuleEnable |
string |
ルールのスイッチ。グローバル構成を追加する場合、このパラメーターを設定する必要はありません。有効値:
|
on |
| Rule |
string |
ルールの内容。条件式を使用してユーザーリクエストを照合します。グローバル構成を追加する場合、このパラメーターを設定する必要はありません。2 つの使用シナリオがあります:
|
(http.request.uri.path.file_name eq \"jpg\") |
例
成功レスポンス
JSONJSON
{
"RequestId": "15C66C7B-671A-4297-9187-2C4477247A123425345",
"WaitingRoomRules": [
{
"WaitingRoomRuleId": 0,
"RuleName": "ip",
"RuleEnable": "on",
"Rule": "(http.request.uri.path.file_name eq \\\"jpg\\\")"
}
]
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InternalException | Failed to call the service. Try again later or contact technical support. | |
| 403 | Site.NotExist | The specified website does not exist or is not recognized by the system.Check whether the specified website identifier is valid and matches a website that is active, defined, and recognized by the system.If you want to add a new website, make sure that the creation and registration process is complete to integrate the website to the system. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。