AS(s) Hosting a Tenant¶

Retrieve the AS(s) Hosting a Tenant¶

GET /api/v1/network/topology/get_hosts_tenant/(string: tenant_id)/¶

Retrieve the list of AS(s) hosting the Tenant.

If the Host’s name is found in the keys of a APIo Backend object, the name of the backend will be added in the answer.

Authorization Right: Minimum Network System Admin.

Example request:

GET /api/v1/network/topology/get_hosts_tenant/ApioEntTest/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
   "hosts": [
      {"name": "bwasdev", "backendName": "AS_XSP_32_58"},
      {"name": "bwasdev2", "backendName": "AS_XSP_32_58"}
   ]
}

Response JSON Object:

hosts (list) – A list of host objects describing the AS hosting the Tenant. There will be usually 1 or 2 entries if in a redundant set-up or not.

Status Codes:

200 OK – no error
404 Not Found – not found

Host attributes¶

Name	Type	Method	Description
Name	Type	GET	Description
name	String	A	The name of the AS hosting theTtenant.
backendName	String	O	The name of the associated Backend in APIO configuration (if configured in the backend definition)
backendExternalName	String	O	An external/logical name for the Backend (if configured in the backend definition)