Get Trusted Clusters KMS Services
Returns detailed information about the given Key Provider Service instance used by the given cluster. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ReadTrustedHosts. - The resource ClusterComputeResource referenced by the parameter cluster requires System.View.
Request
URLURL
https://{api_host}/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/kms/services/{service}
Path Parameters
Path Parameters
string
cluster
Required
The ID of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.
string
service
Required
The ID of the service. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.kms.Service.
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
200 OK returns
TrustedInfrastructureTrustedClustersKmsServicesInfo
of type application/json
Detailed information about the given Key Provider Service instance used by the given cluster.
{
"address": {
"hostname": "string",
"port": 0
},
"group": "string",
"trust_authority_cluster": "string",
"trusted_CA": {
"cert_chain": [
"string"
]
}
}
string
group
Required
The group determines the Attestation Service instances this Key Provider Service can accept reports from.
string
trust_authority_cluster
Required
The cluster specifies the Trust Authority Cluster this Key Provider Service belongs to.
Errors
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-GetClusterServiceKms -Cluster "MyCluster" -Service "MyService"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/kms/services/{service}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get
Availability
Added in 7.0.0.0
