proxygroup.get

説明

integer/array proxygroup.get(object parameters)

このメソッドは、指定したパラメーターに応じたプロキシグループを取得できます。

このメソッドは、すべてのタイプのユーザーが利用できます。メソッドを呼び出す権限は、ユーザーの役割の設定で取り消すことができます。詳細はユーザーの役割を参照してください。

(object) 出力を定義するパラメータ

このメソッドは以下のパラメータをサポートしています。

パラメータ 型 説明
proxy_groupids ID/配列 指定されたIDを持つプロキシグループのみを返します。
proxyids ID/配列 指定されたプロキシを含むプロキシグループのみを返します。
selectProxies クエリ プロキシグループに属するプロキシを含む proxies プロパティを返します。

count をサポートしています。
sortfield 文字列/配列 指定されたプロパティで結果を並べ替えます。

可能な値: proxy_groupid、name
countOutput boolean これらのパラメータについては、リファレンス解説で説明されています。
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

戻り値

(integer/array) 次のいずれかを返します:

  • オブジェクトの配列
  • countOutputパラメータが使用されている場合、取得されたオブジェクトの数

例

全てのプロキシグループの取得

すべての構成済みのプロキシとプロキシグループを取得します。

リクエスト :

{
    "jsonrpc": "2.0",
    "method": "proxygroup.get",
    "params": {
        "output": "extend",
        "selectProxies": ["proxyid", "name"]
    },
    "id": 1
}

レスポンス :

{
    "jsonrpc": "2.0",
    "result": [
        {
            "proxy_groupid": "1",
            "name": "Proxy group 1",
            "failover_delay": "1m",
            "min_online": "3",
            "description": "",
            "state": "1",
            "proxies": [
                {
                    "proxyid": "1",
                    "name": "proxy 1"
                },
                {
                    "proxyid": "2",
                    "name": "proxy 2"
                }
            ]
        },
        {
            "proxy_groupid": "2",
            "name": "Proxy group 2",
            "failover_delay": "10m",
            "min_online": "3",
            "description": "",
            "state": "3",
            "proxies": [
                {
                    "proxyid": "3",
                    "name": "proxy 3"
                },
                {
                    "proxyid": "4",
                    "name": "proxy 4"
                },
                {
                    "proxyid": "5",
                    "name": "proxy 5"
                }
            ]
        }
    ],
    "id": 1
}

参照

ソース

CProxyGroup::get() in ui/include/classes/api/services/CProxyGroup.php.