Get Cluster Configuration Reports Last Apply Result

Returns the most recent available result of applying the configuration document to all hosts within the cluster. if you do not have all of the privileges described as follows:

Operation execution requires VcIntegrity.ClusterConfiguration.View.
The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.View.

Request

URI

GET

https://{api_host}/api/esx/settings/clusters/{cluster}/configuration/reports/last-apply-result

COPY

Path Parameters

string

cluster

Required

The cluster identifier. The parameter must be an identifier for the resource type: ClusterComputeResource.

Authentication

This operation uses the following authentication methods.

api_key

Responses

200

Most recent available result of applying the desired configuration to all hosts within the cluster.

Returns Settings_Clusters_Configuration_ApplyResult of type(s) application/json

{
    "status": {
        "status": "string",
        "attempts": 0,
        "remaining_retries": 0,
        "start_time": "string",
        "end_time": "string",
        "notifications": {
            "info": [
                {
                    "type": "string",
                    "id": "string",
                    "time": "string",
                    "message": {
                        "id": "string",
                        "default_message": "string",
                        "args": [
                            "string"
                        ],
                        "params": {
                            "params": {
                                "s": "string",
                                "dt": "string",
                                "i": 0,
                                "d": "number",
                                "l": {
                                    "id": "string",
                                    "params": {
                                        "params": "Std_LocalizationParam Object"
                                    }
                                },
                                "format": "string",
                                "precision": 0
                            }
                        },
                        "localized": "string"
                    },
                    "resolution": {
                        "id": "string",
                        "default_message": "string",
                        "args": [
                            "string"
                        ],
                        "params": {
                            "params": {
                                "s": "string",
                                "dt": "string",
                                "i": 0,
                                "d": "number",
                                "l": {
                                    "id": "string",
                                    "params": {
                                        "params": "Std_LocalizationParam Object"
                                    }
                                },
                                "format": "string",
                                "precision": 0
                            }
                        },
                        "localized": "string"
                    },
                    "originator": "string",
                    "retriable": false
                }
            ],
            "warnings": [
                {
                    "type": "string",
                    "id": "string",
                    "time": "string",
                    "message": {
                        "id": "string",
                        "default_message": "string",
                        "args": [
                            "string"
                        ],
                        "params": {
                            "params": {
                                "s": "string",
                                "dt": "string",
                                "i": 0,
                                "d": "number",
                                "l": {
                                    "id": "string",
                                    "params": {
                                        "params": "Std_LocalizationParam Object"
                                    }
                                },
                                "format": "string",
                                "precision": 0
                            }
                        },
                        "localized": "string"
                    },
                    "resolution": {
                        "id": "string",
                        "default_message": "string",
                        "args": [
                            "string"
                        ],
                        "params": {
                            "params": {
                                "s": "string",
                                "dt": "string",
                                "i": 0,
                                "d": "number",
                                "l": {
                                    "id": "string",
                                    "params": {
                                        "params": "Std_LocalizationParam Object"
                                    }
                                },
                                "format": "string",
                                "precision": 0
                            }
                        },
                        "localized": "string"
                    },
                    "originator": "string",
                    "retriable": false
                }
            ],
            "errors": [
                {
                    "type": "string",
                    "id": "string",
                    "time": "string",
                    "message": {
                        "id": "string",
                        "default_message": "string",
                        "args": [
                            "string"
                        ],
                        "params": {
                            "params": {
                                "s": "string",
                                "dt": "string",
                                "i": 0,
                                "d": "number",
                                "l": {
                                    "id": "string",
                                    "params": {
                                        "params": "Std_LocalizationParam Object"
                                    }
                                },
                                "format": "string",
                                "precision": 0
                            }
                        },
                        "localized": "string"
                    },
                    "resolution": {
                        "id": "string",
                        "default_message": "string",
                        "args": [
                            "string"
                        ],
                        "params": {
                            "params": {
                                "s": "string",
                                "dt": "string",
                                "i": 0,
                                "d": "number",
                                "l": {
                                    "id": "string",
                                    "params": {
                                        "params": "Std_LocalizationParam Object"
                                    }
                                },
                                "format": "string",
                                "precision": 0
                            }
                        },
                        "localized": "string"
                    },
                    "originator": "string",
                    "retriable": false
                }
            ]
        }
    },
    "commit": "string",
    "software_commit": "string",
    "host_info": {
        "host_info": {
            "name": "string",
            "is_vsan_witness": false
        }
    },
    "host_status": {
        "host_status": {
            "status": "string",
            "attempts": 0,
            "remaining_retries": 0,
            "start_time": "string",
            "end_time": "string",
            "notifications": {
                "info": [
                    {
                        "type": "string",
                        "id": "string",
                        "time": "string",
                        "message": {
                            "id": "string",
                            "default_message": "string",
                            "args": [
                                "string"
                            ],
                            "params": {
                                "params": {
                                    "s": "string",
                                    "dt": "string",
                                    "i": 0,
                                    "d": "number",
                                    "l": {
                                        "id": "string",
                                        "params": {
                                            "params": "Std_LocalizationParam Object"
                                        }
                                    },
                                    "format": "string",
                                    "precision": 0
                                }
                            },
                            "localized": "string"
                        },
                        "resolution": {
                            "id": "string",
                            "default_message": "string",
                            "args": [
                                "string"
                            ],
                            "params": {
                                "params": {
                                    "s": "string",
                                    "dt": "string",
                                    "i": 0,
                                    "d": "number",
                                    "l": {
                                        "id": "string",
                                        "params": {
                                            "params": "Std_LocalizationParam Object"
                                        }
                                    },
                                    "format": "string",
                                    "precision": 0
                                }
                            },
                            "localized": "string"
                        },
                        "originator": "string",
                        "retriable": false
                    }
                ],
                "warnings": [
                    {
                        "type": "string",
                        "id": "string",
                        "time": "string",
                        "message": {
                            "id": "string",
                            "default_message": "string",
                            "args": [
                                "string"
                            ],
                            "params": {
                                "params": {
                                    "s": "string",
                                    "dt": "string",
                                    "i": 0,
                                    "d": "number",
                                    "l": {
                                        "id": "string",
                                        "params": {
                                            "params": "Std_LocalizationParam Object"
                                        }
                                    },
                                    "format": "string",
                                    "precision": 0
                                }
                            },
                            "localized": "string"
                        },
                        "resolution": {
                            "id": "string",
                            "default_message": "string",
                            "args": [
                                "string"
                            ],
                            "params": {
                                "params": {
                                    "s": "string",
                                    "dt": "string",
                                    "i": 0,
                                    "d": "number",
                                    "l": {
                                        "id": "string",
                                        "params": {
                                            "params": "Std_LocalizationParam Object"
                                        }
                                    },
                                    "format": "string",
                                    "precision": 0
                                }
                            },
                            "localized": "string"
                        },
                        "originator": "string",
                        "retriable": false
                    }
                ],
                "errors": [
                    {
                        "type": "string",
                        "id": "string",
                        "time": "string",
                        "message": {
                            "id": "string",
                            "default_message": "string",
                            "args": [
                                "string"
                            ],
                            "params": {
                                "params": {
                                    "s": "string",
                                    "dt": "string",
                                    "i": 0,
                                    "d": "number",
                                    "l": {
                                        "id": "string",
                                        "params": {
                                            "params": "Std_LocalizationParam Object"
                                        }
                                    },
                                    "format": "string",
                                    "precision": 0
                                }
                            },
                            "localized": "string"
                        },
                        "resolution": {
                            "id": "string",
                            "default_message": "string",
                            "args": [
                                "string"
                            ],
                            "params": {
                                "params": {
                                    "s": "string",
                                    "dt": "string",
                                    "i": 0,
                                    "d": "number",
                                    "l": {
                                        "id": "string",
                                        "params": {
                                            "params": "Std_LocalizationParam Object"
                                        }
                                    },
                                    "format": "string",
                                    "precision": 0
                                }
                            },
                            "localized": "string"
                        },
                        "originator": "string",
                        "retriable": false
                    }
                ]
            }
        }
    },
    "successful_hosts": [
        "string"
    ],
    "failed_hosts": [
        "string"
    ],
    "skipped_hosts": [
        "string"
    ]
}

Settings_Clusters_Configuration_HostStatus

status

Optional

The HostStatus structure contains fields that describe the status of an operation.

string

commit

Required

The identifier of the commit used to fetch the desired configuration document to be applied to all hosts within the cluster. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.esx.settings.commit. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.esx.settings.commit.

string

software_commit

Required

The current commit ID for the software associated with the cluster. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.esx.settings.commit. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.esx.settings.commit.

object

host_info

Required

Information of the hosts in this cluster to which the desired configuration document specified by the Configuration.ApplyResult.commit should be applied to. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: HostSystem. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: HostSystem.

object

host_status

Required

Status of the hosts in this cluster to which the desired configuration specified by the Configuration.ApplyResult.commit was applied to. Hosts on which the Configuration.apply operation was successful are specified by Configuration.ApplyResult.successful-hosts. Hosts on which the apply operation failed are specified by Configuration.ApplyResult.failed-hosts. Hosts which were skipped by the Configuration.apply operation are specified by Configuration.ApplyResult.skipped-hosts. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: HostSystem. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: HostSystem.

array of string

successful_hosts

Required

Hosts in this cluster to which the desired configuration specified by the Configuration.ApplyResult.commit has been successfully applied to. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: HostSystem. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: HostSystem.

array of string

failed_hosts

Required

Hosts in this cluster to which the desired configuration specified by the Configuration.ApplyResult.commit failed to be applied. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: HostSystem. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: HostSystem.

array of string

skipped_hosts

Required

Hosts in this cluster that were skipped by the Configuration.apply operation. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: HostSystem. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: HostSystem.

401

com.vmware.vapi.std.errors.unauthenticated : if the caller is not authenticated.

Returns Std_Errors_Error of type(s) application/json

{
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": {
                        "id": "string",
                        "params": {
                            "params": "Std_LocalizationParam Object"
                        }
                    },
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ],
    "data": {},
    "error_type": "string"
}

array of Std_LocalizableMessage

messages

Required

Stack of one or more localizable messages for human error consumers. The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

object

data

Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully. Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.

The ArgumentLocations, FileLocations, and TransientIndication structures are intended as possible values for this field. DynamicID may also be useful as a value for this field (although that is not its primary purpose). Some services may provide their own specific structures for use as the value of this field when reporting errors from their operations.

Some operations will not set this field when reporting errors.

Std_Errors_Error_Type

error_type

Optional

Enumeration of all standard errors. Used as discriminator in protocols that have no standard means for transporting the error type, e.g. REST.
ERROR : Discriminator for the Error type.
ALREADY_EXISTS : Discriminator for the AlreadyExists type.
ALREADY_IN_DESIRED_STATE : Discriminator for the AlreadyInDesiredState type.
CANCELED : Discriminator for the Canceled type.
CONCURRENT_CHANGE : Discriminator for the ConcurrentChange type.
FEATURE_IN_USE : Discriminator for the FeatureInUse type.
INTERNAL_SERVER_ERROR : Discriminator for the InternalServerError type.
INVALID_ARGUMENT : Discriminator for the InvalidArgument type.
INVALID_ELEMENT_CONFIGURATION : Discriminator for the InvalidElementConfiguration type.
INVALID_ELEMENT_TYPE : Discriminator for the InvalidElementType type.
INVALID_REQUEST : Discriminator for the InvalidRequest type.
NOT_ALLOWED_IN_CURRENT_STATE : Discriminator for the NotAllowedInCurrentState type.
NOT_FOUND : Discriminator for the NotFound type.
OPERATION_NOT_FOUND : Discriminator for the OperationNotFound type.
RESOURCE_BUSY : Discriminator for the ResourceBusy type.
RESOURCE_IN_USE : Discriminator for the ResourceInUse type.
RESOURCE_INACCESSIBLE : Discriminator for the ResourceInaccessible type.
SERVICE_UNAVAILABLE : Discriminator for the ServiceUnavailable type.
TIMED_OUT : Discriminator for the TimedOut type.
UNABLE_TO_ALLOCATE_RESOURCE : Discriminator for the UnableToAllocateResource type.
UNAUTHENTICATED : Discriminator for the Unauthenticated type.
UNAUTHORIZED : Discriminator for the Unauthorized type.
UNEXPECTED_INPUT : Discriminator for the UnexpectedInput type.
UNSUPPORTED : Discriminator for the Unsupported type.
UNVERIFIED_PEER : Discriminator for the UnverifiedPeer type.

403

com.vmware.vapi.std.errors.unauthorized : if the caller does not have the necessary privileges to perform the request.

Returns Std_Errors_Error of type(s) application/json

{
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": {
                        "id": "string",
                        "params": {
                            "params": "Std_LocalizationParam Object"
                        }
                    },
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ],
    "data": {},
    "error_type": "string"
}

array of Std_LocalizableMessage

messages

Required

Each subsequent message in the stack describes the "cause" of the prior message.

object

data

Optional

Some operations will not set this field when reporting errors.

Std_Errors_Error_Type

error_type

Optional

404

com.vmware.vapi.std.errors.not_found : If there is no cluster associated with cluster in the system or if there is no result associated with the cluster cluster

Returns Std_Errors_Error of type(s) application/json

{
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": {
                        "id": "string",
                        "params": {
                            "params": "Std_LocalizationParam Object"
                        }
                    },
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ],
    "data": {},
    "error_type": "string"
}

array of Std_LocalizableMessage

messages

Required

Each subsequent message in the stack describes the "cause" of the prior message.

object

data

Optional

Some operations will not set this field when reporting errors.

Std_Errors_Error_Type

error_type

Optional

500

com.vmware.vapi.std.errors.error : If there is an unknown internal error. The accompanying error message will give more details about the failure.

Returns Std_Errors_Error of type(s) application/json

{
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": {
                        "id": "string",
                        "params": {
                            "params": "Std_LocalizationParam Object"
                        }
                    },
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ],
    "data": {},
    "error_type": "string"
}

array of Std_LocalizableMessage

messages

Required

Each subsequent message in the stack describes the "cause" of the prior message.

object

data

Optional

Some operations will not set this field when reporting errors.

Std_Errors_Error_Type

error_type

Optional

503

com.vmware.vapi.std.errors.service_unavailable : If the service is not available.

Returns Std_Errors_Error of type(s) application/json

{
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": {
                        "id": "string",
                        "params": {
                            "params": "Std_LocalizationParam Object"
                        }
                    },
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ],
    "data": {},
    "error_type": "string"
}

array of Std_LocalizableMessage

messages

Required

Each subsequent message in the stack describes the "cause" of the prior message.

object

data

Optional

Some operations will not set this field when reporting errors.

Std_Errors_Error_Type

error_type

Optional

default

'Default' means this response is used for all HTTP codes that are not covered individually for this operation.

Returns Std_Errors_Error of type(s) application/json

{
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": {
                        "id": "string",
                        "params": {
                            "params": "Std_LocalizationParam Object"
                        }
                    },
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ],
    "data": {},
    "error_type": "string"
}

array of Std_LocalizableMessage

messages

Required

Each subsequent message in the stack describes the "cause" of the prior message.

object

data

Optional

Some operations will not set this field when reporting errors.

Std_Errors_Error_Type

error_type

Optional