Assign Tags To Host | VMware Cloud Foundation for VxRail API

Assign Tags To Host

Assign tags to a host

Request

URI

PUT

https://sfo-vcf01.rainpole.io//v1/hosts/{id}/tags

COPY

Path Parameters

string

Required

Host ID

Request Body

TagsSpec of type(s) application/json

Optional

{
    "tagIds": [
        "string"
    ]
}

array of string

tagIds

Required

Tag IDs

Responses

200

Returns TagAssignmentResult of type(s) application/json

{
    "defaultErrorMessages": [
        "string"
    ],
    "success": false
}

array of string

defaultErrorMessages

Optional

Default Error messages for Assign/Detach Tags operation

boolean

success

Optional

Success value of Assign/Detach Tags operation

400

Bad Request

Returns Error of type(s) application/json

{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "errorCode": "string",
    "errorType": "string",
    "message": "string",
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}

array of string

arguments

Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

array of ErrorCause

causes

Optional

The underlying cause exceptions.

object

context

Optional

The error context (e.g. the component where it occurred).

string

errorCode

Optional

The minor error code

string

errorType

Optional

The error type

string

message

Optional

The localized error message

array of Error

nestedErrors

Optional

The nested errors when the error is a composite one

string

referenceToken

Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

string

remediationMessage

Optional

The localized remediation error message

500

InternalServerError

Returns Error of type(s) application/json

{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "errorCode": "string",
    "errorType": "string",
    "message": "string",
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}

array of string

arguments

Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

array of ErrorCause

causes

Optional

The underlying cause exceptions.

object

context

Optional

The error context (e.g. the component where it occurred).