Esx. Settings. Internal. Summary Get

Esx. Settings. Internal. Summary Get

Summarize the compliance result of the clusters. The API will return the cluster summary with an empty compliance result and/or desired software specification if the service failed to get this information from the database due to unexpected scenarios.

This operation was added in vSphere API 7.0.0.0.

Returns an authorization error if you do not have all of the privileges described as follows:

  • Operation execution requires VcIntegrity.lifecycleSettings.Read.
Request
URI
GET
https://{api_host}/esx/settings/internal/summary
COPY
Query Parameters
Esx.Settings.Internal.Summary.RootEntity
entity
Optional

Identifier of the entity to perform cluster compliance get operation.

If missing or null, the compliance result of all the clusters of the entity type vcenter will be returned.

Authentication
This operation uses the following authentication methods.
Responses
200

Compliance summary of all the clusters.

The key in the response map will be an identifier for the resource type: ClusterComputeResource.

{
    "0": "E",
    "1": "s",
    "2": "x",
    "3": ".",
    "4": "S",
    "5": "e",
    "6": "t",
    "7": "t",
    "8": "i",
    "9": "n",
    "10": "g",
    "11": "s",
    "12": ".",
    "13": "I",
    "14": "n",
    "15": "t",
    "16": "e",
    "17": "r",
    "18": "n",
    "19": "a",
    "20": "l",
    "21": ".",
    "22": "S",
    "23": "u",
    "24": "m",
    "25": "m",
    "26": "a",
    "27": "r",
    "28": "y",
    "29": ".",
    "30": "C",
    "31": "l",
    "32": "u",
    "33": "s",
    "34": "t",
    "35": "e",
    "36": "r",
    "37": "S",
    "38": "u",
    "39": "m",
    "40": "m",
    "41": "a",
    "42": "r",
    "43": "y",
    "44": " ",
    "45": "O",
    "46": "b",
    "47": "j",
    "48": "e",
    "49": "c",
    "50": "t"
}

401

If the caller is not authenticated.

Returns Vapi.Std.Errors.Unauthenticated of type(s) application/json 
"Vapi.Std.Errors.Unauthenticated Object"

404

If there is no entity found in the system.

Returns Vapi.Std.Errors.NotFound of type(s) application/json 
"Vapi.Std.Errors.NotFound Object"

500

If there is unknown internal error. The accompanying error message will give more details about the failure.

Returns Vapi.Std.Errors.Error of type(s) application/json 
"Vapi.Std.Errors.Error Object"

503

If the service is not available.

Returns Vapi.Std.Errors.ServiceUnavailable of type(s) application/json 
"Vapi.Std.Errors.ServiceUnavailable Object"

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/esx/settings/internal/summary
On This Page
Esx.settings.internal.summary Operations
GET
Esx. Settings. Internal. Summary Get
POST
Esx. Settings. Internal. Summary Scan$ Task