Get Trusted Clusters KMS Services Applied Config Task
Returns detailed information about the health of the specified Key Provider Service configuration applied to the cluster with respect to the desired state.
Request
URLURL
https://{api_host}/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/kms/services-applied-config?vmw-task=true
Path Parameters
Path Parameters
string
cluster
Required
The ID of the cluster against which the operation will be executed. The parameter must be an identifier for the resource type: ClusterComputeResource.
Query Parameters
Query Parameters
string
hostname
Optional
The IP address or DNS resolvable name of the service.
integer
port
Optional
The port of the service. If unset, port 443 will be used.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
202 Accepted returns
string
of type application/json
An identifier for the task created by this API invocation will be returned. If the non-async version of the operation returns a value, this id can be used with the CIS Get Task operation to fetch that value. The normal description of this operation’s return value will follow if one exists. Detailed information about the health of the specified Key Provider Service configuration applied to the cluster with respect to the desired state.
Errors
404
com.vmware.vapi.std.errors.not_found : if no cluster corresponding to the given ID is found within this vCenter or if no service corresponding to the given address is found.
500
com.vmware.vapi.std.errors.error : if there is a generic error. | com.vmware.vapi.std.errors.resource_busy : if there are ongoing mutating operations.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-GetClusterKmsServicesAppliedConfigAsync -Cluster "MyCluster" -Hostname "MyHostname" -Port 789
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/kms/services-applied-config?vmw-task=true
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get_task
Availability
Added in 7.0.1.0
