getEndpointsList: төгсгөлийн төхөөрөмжүүдийн жагсаалт авах

Энэ method нь төгсгөлийн төхөөрөмжүүдийн жагсаалтыг буцаана.

Service-үүд

Энэ method нь API URL-д {service} нэрийг оруулахыг шаардана. Зөвшөөрөгдсөн service-үүд:

• computers - "Computers and Virtual Machines" хувьд
• virtualmachines - "Virtual Machines" хувьд

Жишээ нь virtualmachines service-ийн хүсэлтийн URL:

https://YOUR-HOSTNAME/api/v1.0/jsonrpc/network/virtualmachines

Параметрүүд

Available Filters (боломжит шүүлтүүрүүд)

filters параметрээр төгсгөлийн төхөөрөмжүүдийг тодорхой шинж чанараар лавлаж болно. Шүүлтүүрүүд хэсэг (section) болон дэд хэсэг (subsection)-үүдэд бүтэцлэгдсэн.

Лавлагааны үр дүн нь БҮХ хэсэг БОЛОН дэд хэсгүүдийн сонгосон ЯМАР Ч шүүлтүүрт таарсан төгсгөлийн төхөөрөмжүүдийн жагсаалт байна.

Боломжит шүүлтүүрийн сонголтууд:

Чухал

Зарим шүүлтүүр тодорхой лиценз идэвхтэй байхыг шаарддаг. Эс бөгөөс тэдгээрийг үл тооно, ингэснээр API-ийн хариу буруу байж болно.

name талбар хэсэгчилсэн тохирлоор ажиллана.

Шүүлтүүр нь нэр нь заасан утгатай яг таарсан эсвэл тэр утгаар эхэлсэн төгсгөлийн төхөөрөмжүүдийг буцаана. Заасан утгыг дагавар болгон ашиглахын тулд од (*) тэмдэг хэрэглэнэ.

Жишээ нь:

name нь computer бол API нь нэр нь computer-ээр эхэлсэн бүх төгсгөлийн төхөөрөмжийг буцаана.

name нь *puter бол API нь нэрэндээ puter агуулсан бүх төгсгөлийн төхөөрөмжийн жагсаалтыг буцаана.

Available options (боломжит сонголтууд)

options параметрээр API-ийн хариунд ямар мэдээлэл орохыг тохируулж болно. Сонголтууд хэсэг, дэд хэсгүүдэд бүтэцлэгдсэн.

Боломжит сонголтууд:

Буцаах утга

Энэ method нь төгсгөлийн төхөөрөмжүүдийн мэдээллийг агуулсан Object буцаана. Буцаах объект дараахыг агуулна:

• page - одоогийн хуудас
• pagesCount - нийт хуудасны тоо
• perPage - нэг хуудсанд буцаасан зүйлсийн нийт тоо
• total - нийт зүйлсийн тоо
• items - төгсгөлийн төхөөрөмжүүдийн жагсаалт агуулсан array. Жагсаалтын оруулга бүр дараах талбартай:
  • id, удирдагдаж буй төгсгөлийн төхөөрөмжийн ID,
  • name, төгсгөлийн төхөөрөмжийн нэр,
  • label, энэ төгсгөлийн төхөөрөмжид оноосон шошго,
  • fqdn, төгсгөлийн төхөөрөмжийн FQDN (бүтэн домэйн нэр),
  • groupId, төгсгөлийн төхөөрөмжийн бүлгийн ID,
  • isManaged, энэ төгсгөлийн төхөөрөмж удирдагдаж байвал boolean True,
  • machineType, машины төрөл: (1 - computer, 2 - virtual machine, 3 - EC2 Instance, 0 - Other),
  • operatingSystemVersion, төгсгөлийн төхөөрөмжийн үйлдлийн системийн хувилбар,
  • isIsolated - төгсгөлийн төхөөрөмж одоогоор тусгаарлах (isolation) үйлдлээр сүлжээнээс тусгаарлагдсан эсэхийг заасан Boolean,
  • ip, төгсгөлийн төхөөрөмжийн локал IP хаяг,
  • publicIp, төгсгөлийн төхөөрөмжийн олон нийтийн (public) IP хаяг,
  • macs, төгсгөлийн төхөөрөмжийн MAC хаягууд,
  • ssid, төгсгөлийн төхөөрөмжийн SSID (Active Directory SID),
  • managedWithBest, энэ төгсгөлийн төхөөрөмж дээр BEST суулгасан бол boolean True,
  • isContainerHost, энэ төгсгөлийн төхөөрөмж Container Host бол boolean True,
  • managedExchangeServer, энэ төгсгөлийн төхөөрөмж Exchange Server бол boolean True,
  • managedRelay, энэ төгсгөлийн төхөөрөмж Relay үүрэгтэй бол boolean True,
  • securityServer, энэ төгсгөлийн төхөөрөмж Security Server бол boolean True,
  • managedWithNsx, энэ нь VMware NSX дата төвийн төгсгөлийн төхөөрөмж бол boolean True.
  • managedWithVShield, энэ нь VMware vShield орчны төгсгөлийн төхөөрөмж бол boolean True.
  • productOutdated, төгсгөлийн төхөөрөмжид agent-ийн нэг буюу хэд хэдэн шинэчлэл дутуу бол boolean True.

Жишээ

Хүсэлт:

{
      "params": {
           "parentId": "63c6bb02e3cb799758020b99",
           "page": 1,
           "perPage": 10,
           "filters": {
                   "security": {
                            "management": {
                                "managedWithBest": true,
                                "managedRelays": true
				}
                   }
		},
           "options": {
                   "returnProductOutdated": true,
                   "includeScanLogs": true
           }
      },
      "jsonrpc": "2.0",
      "method": "getEndpointsList",
      "id": "301f7b05-ec02-481b-9ed6-c07b97de2b7b"
}

Хариу:

{
  "result": {
    "total": 1,
    "page": 1,
    "perPage": 30,
    "pagesCount": 1,
    "items": [
      {
        "id": "64b7625d3c11463ef77e5d6d",
        "name": "string00:16:3e:7f:d3:2e",
        "label": "",
        "fqdn": "s0lc5.wkorh.dsd.ro",
        "groupId": "64b503c21ecee42e130a7bc9",
        "isManaged": true,

        "operatingSystemVersion": "Windows 7 Professional",

        "isIsolated": false,
        "ip": "231.180.244.114",
        "publicIp": "203.0.113.185",
        "macs": [
          "00:16:3e:7f:d3:2e"
        ],
        "ssid": "",

        "productOutdated": false,
        "lastSuccessfulScan": {
          "name": "72OHI5dnIH",
          "date": "2023-07-19T04:09:29+00:00"
        }
      }
    ]
  },
  "jsonrpc": "2.0",
  "
}