Get Hosts | Telco Cloud Foundation Manager API

Get Hosts

This API is to be used for getting the hosts as per the specified parameters.

Request

URI

GET

https://{api_host}/hybridity/api/ztp/v1/hosts

COPY

Query Parameters

string

sort

Optional

The key to use for sorting the resultant list of hosts. The value is to be an attribute based sorting expression. The supported attributes for sorting are as follows: [ name, status, hostSettingStatus, id, version, domainId, parent, username, password, ipmiFqdn, ipmiUsername, ipmiPassword, vmkVsanIp, vmkVmotionIp, createdTimestamp, lastUpdatedTimestamp ]. The supported sorting orders are: [asc,desc]

sort example

createdTimestamp,desc

string

filter

Optional

Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013. The supported filter types are [cont, eq]. "cont" refers to contains (substring check). It is applicable only for string type targets. "eq" refers to exact match. If target type is a string, then case is ignored. The supported attributes for "eq" filtering are: [ name, status, hostSettingStatus, id, version, domainId, parent, username, password, ipmiFqdn, ipmiUsername, ipmiPassword, vmkVsanIp, vmkVmotionIp ]. The supported attributes for "cont" filtering are: [ name, status, hostSettingStatus, id, domainId, parent, username, password, ipmiFqdn, ipmiUsername, ipmiPassword, vmkVsanIp, vmkVmotionIp ]. For example: (cont,name,abc.com);(eq,status,IN_PROGRESS)

string

nextpage_opaque_marker

Optional

Marker to obtain the next page of a paged response according to clause 5.4.2.1 of ETSI GS NFV SOL 013 for this resource. The marker expression will contain page number and page size.

nextpage_opaque_marker example

page_no=1,page_size=10

Authentication

This operation uses the following authentication methods.

x-hm-authorization

Responses

200

Response includes list of hosts as specified by the request parameters.

Returns Array of InlineZtpV1Hosts200Response of type(s) application/json

[
    {
        "id": "string",
        "version": 0,
        "domainId": "string",
        "domainType": "string",
        "parent": "string",
        "ip": "string",
        "name": "string",
        "username": "string",
        "status": "string",
        "createdTimestamp": 0,
        "lastUpdatedTimestamp": 0,
        "disableDatastoreCustomization": false,
        "ipmiFqdn": "string",
        "ipmiUsername": "string",
        "hostSettingStatus": "string",
        "isVcpResyncNeeded": false,
        "isHcpResyncNeeded": false,
        "errors": [
            {
                "code": "string",
                "message": "string",
                "stack": "string"
            }
        ]
    }
]

Response Headers

integer

X-TotalPageCount

The total number of pages for hosts present on the server.

integer

X-TotalRowCount

The total number of hosts present on the server.

301

API endpoint has permanently moved.

Returns InlineZtpV1Hosts301Response of type(s) application/json

{
    "redirectURL": "string"
}

string

redirectURL

Optional

redirectURL

Response Headers

string

Location

URI where the client will find the new endpoint.

400

Response may include details of why the request is bad.

Returns InlineZtpV1Hosts400Response of type(s) application/json

{
    "warnings": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ],
    "errors": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ]
}

array of object

warnings

Optional

The list of warnings.

array of object

errors

Optional

The list of errors.

401

User is not authenticated to invoke this endpoint.

Operation doesn't return any data structure

403

User is not authorized to invoke this endpoint.

Operation doesn't return any data structure

422

The request parameters couldn't be processed by the server.

Returns InlineZtpV1Hosts422Response of type(s) application/json

{
    "warnings": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ],
    "errors": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ]
}

array of object

warnings

Optional

The list of warnings.

array of object

errors

Optional

The list of errors.

500

An internal server error has occurred.

Returns InlineZtpV1Hosts500Response of type(s) application/json

{
    "warnings": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ],
    "errors": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ]
}

array of object

warnings

Optional

The list of warnings.

array of object

errors

Optional

The list of errors.

On This Page

Description

Request

Query Parameters