Agent リストの取得
Groups/{ Group name}/list API を使用すると、特定の ビルド グループに属するすべてのエージェントのリストを返すことができます。
リクエストの構文
GET https://{Coordinator IP Address/Hostname}:{Web Access Port}/Groups/{Group name}/list
コマンドの詳細:
-
Web Access Port は、[Coordinator Settings] で定義されたポート番号です(デフォルトは31100 )。
-
グループ名は大文字と小文字を区別します。
コマンドの例:
GET https://win10-1:31100/Groups/Dev/list
レスポンスの構文
指定したビルド グループ内の Agent (IP アドレスとホスト名) のリストを返します。
コマンドの例:
[
{
"IP": "192.100.00.002",
"Name": "WIN10-2"
},
{
"IP": "192.100.00.001",
"Name": "WIN10-1"
},
{
"IP": "192.100.00.003",
"Name": "HOST-29"
}
]
コマンドの詳細:
-
IP - エージェントのIPアドレスです。
-
Name - エージェントのホスト名です。
エラーの発生条件
次の場合リクエストは失敗します。
-
ビルド グループに Agent が含まれない場合。
-
ビルド グループが存在しない場合。
リクエストに失敗した場合は、次のように返されます:「Status」: 「Not found」
コマンドの例:
[
{
"Group": "New",
"Status": "Not found"
}
]