Fetch Hosts By Name | Telco Cloud Foundation Manager API

Fetch Hosts By Name

This API is to be used for fetching the Hosts based on host names.

Request

URI

POST

https://{api_host}/hybridity/api/ztp/v1/hosts/fetch-by-names

COPY

Request Body

The request payload for Fetch Hosts By Names API.

InlineZtpV1HostsFetchByNamesRequestBody of type(s) application/json

Required

{
    "hosts": [
        "string"
    ]
}

array of string

hosts

Required

The FQDN of the Hosts.

Authentication

This operation uses the following authentication methods.

x-hm-authorization

Responses

200

Response includes list of hosts as specified by the host names.

Returns InlineZtpV1HostsFetchByNames200Response of type(s) application/json

{
    "hosts": [
        {
            "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"
                }
            ]
        }
    ],
    "notfound": [
        "string"
    ]
}

array of object

hosts

Optional

The list of hosts available.

array of string

notfound

Optional

The list of host names which are not available.

301

API endpoint has permanently moved.

Returns InlineZtpV1HostsFetchByNames301Response 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 InlineZtpV1HostsFetchByNames400Response 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 payload couldn't be processed by the server.

Returns InlineZtpV1HostsFetchByNames422Response 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 InlineZtpV1HostsFetchByNames500Response 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

Request Body