Get KMS Services
Returns the detailed information about a registered Key Provider Service instance in this vCenter. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ReadTrustedHosts.
Request
URLURL
https://{api_host}/api/vcenter/trusted-infrastructure/kms/services/{service}
Path Parameters
Path Parameters
string
service
Required
the Key Provider Service instance unique identifier. 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
TrustedInfrastructureKmsServicesInfo
of type application/json
Detailed information about the specified Key Provider Service instance.
{
"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
404
com.vmware.vapi.std.errors.not_found : if there is no Key Provider Service instance with the specified ID.
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-GetServiceKms -Service "MyService"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/trusted-infrastructure/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
