Esx Settings Clusters Configuration AuditRecords list

Esx Settings Clusters Configuration AuditRecords list

Retrieves audit information about the configuration actions performed on the cluster.

This operation was added in vSphere API 8.0.2.0.

Returns an authorization error 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/audit-records
COPY
Path Parameters
string
cluster
Required

Identifier of the cluster.

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

Query Parameters
Esx Settings Clusters Configuration AuditRecords FilterSpec
filters
Optional

used to filter the audit records.

If missing or null returns all available audit records associated with cluster

string of array
operations
Optional

List of audit records that match the given operations An operation in operations can be any of

  • Import
  • Export
  • Remediate
  • Checkcompliance
  • Precheck
  • Transition-Enable
  • Draft-List
  • Draft-Create
  • Draft-ImportFromHost
  • Draft-Get
  • Draft-ExportConfig
  • Draft-Update
  • Draft-ShowChanges
  • Draft-CheckCompliance
  • Draft-Precheck
  • Draft-Delete
  • Draft-Apply
  • Draft-GetSchema

This property was added in vSphere API 8.0.2.0.

If missing or null or empty, records with any operation match the filter.

string of array
usernames
Optional

List of audit records that match the given users

This property was added in vSphere API 8.0.2.0.

If missing or null or empty, records with any users match the filter.

string
start
Optional

List of audit records that match the given start time i.e. occurred after the DateTime start.

This property was added in vSphere API 8.0.2.0.

string
end
Optional

List of audit records that match the given end time i.e. occurred before the DateTime end.

This property was added in vSphere API 8.0.2.0.

Authentication
This operation uses the following authentication methods.
Responses
200

audit Information about the cluster associated with cluster.

[
    "Esx Settings Clusters Configuration AuditRecords Info Object"
]
array of Esx Settings Clusters Configuration AuditRecords Info
Optional

401

if the session id is missing from the request or the corresponding session object cannot be found.

Returns Vapi Std Errors Unauthenticated of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthenticated0 
"Vapi Std Errors Unauthenticated Object"
string
challenge
Optional

Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.

For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"

This property was added in vSphere API 7.0.0.0.

This property is optional because it was added in a newer version than its parent node.


403

if the user doesn't not have the required privileges.

Returns Vapi Std Errors Unauthorized of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthorized0 
"Vapi Std Errors Unauthorized Object"

404

if there is no cluster associated with cluster in the system.

Returns Vapi Std Errors NotFound of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors NotFound0 
"Vapi Std Errors NotFound Object"

503

if the system is unable to communicate with a service to complete the request.

Returns Vapi Std Errors ServiceUnavailable of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors ServiceUnavailable0 
"Vapi Std Errors ServiceUnavailable Object"

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/esx/settings/clusters/{cluster}/configuration/audit-records
On This Page
Esx Settings Operations
GET
Esx Settings Clusters Configuration AuditRecords list