computing / Client / nifty_describe_web_proxies

nifty_describe_web_proxies

computing.Client.nifty_describe_web_proxies(**kwargs)

ルーターに設定されているWebプロキシの設定情報を取得します。

ルーターを指定するためには、ルーターユニークIDまたはルーター名が必要です。

ルーターを指定しない場合、取得できるすべてのルーター情報を取得します。

絞り込み条件の項目の値「Filter.n.Value.m」を指定する際、ワイルドカード文字（曖昧検索）指定可能です。「∗」は0個以上任意文字、 「?」は1個任意文字、「¥」はエスケープ変換文字（「∗niftycloud¥?¥¥」は「∗niftycloud?¥」を検索）となります。

曖昧検索が指定可能な絞り込み条件の項目名は、下記の通りです。

• router-name

• listen-network-name

• listen-port

• proxy-bypass-network-name

• option-name-server

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_describe_web_proxies(
    Filter=[
        {
            'ListOfRequestValue': [
                'string',
            ],
            'Name': 'router-id'|'router-name'|'listen-network-id'|'listen-network-name'|'listen-port'|'proxy-bypass-network-id'|'proxy-bypass-network-name'|'option-name-server'
        },
    ],
    RouterId=[
        'string',
    ],
    RouterName=[
        'string',
    ]
)

Parameters:

• Filter (list) –

  • (dict) –

    • ListOfRequestValue (list) –

      • (string) –

    • Name (string) –

• RouterId (list) –

  • (string) –

• RouterName (list) –

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'WebProxy': [
        {
            'BypassInterface': {
                'NetworkId': 'string',
                'NetworkName': 'string'
            },
            'Description': 'string',
            'ListenInterface': {
                'NetworkId': 'string',
                'NetworkName': 'string'
            },
            'ListenPort': 'string',
            'Option': {
                'NameServer': 'string'
            },
            'RouterId': 'string',
            'RouterName': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • RequestId (string) –

  • WebProxy (list) –

    • (dict) –

      • BypassInterface (dict) –

        • NetworkId (string) –

        • NetworkName (string) –

      • Description (string) –

      • ListenInterface (dict) –

        • NetworkId (string) –

        • NetworkName (string) –

      • ListenPort (string) –

      • Option (dict) –

        • NameServer (string) –

      • RouterId (string) –

      • RouterName (string) –