Developer Documentation
Get Trust Authority Hosts KMS
Released in v7.0.0Returns the connection info about the Key Provider Service running on the specified host. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ReadTrustedHosts. - The resource HostSystem referenced by the parameter host requires System.View.
Request
URLURL
https://{api_host}/api/vcenter/trusted-infrastructure/trust-authority-hosts/{host}/kms
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | @{link com.vmware.vcenter.Host} id. The parameter must be an identifier for the resource type: HostSystem. |
Response
Response
Response BodyResponse Body
200 OK returns
KmsInfo
of type application/json
The Kms.Info instance which contains the information necessary to connect to the Key Provider Service.
{
"address": {
"hostname": "string",
"port": 0
},
"cluster": "string",
"group": "string",
"host": "string",
"trusted_CA": {
"cert_chain": [
"string"
]
}
}| Property Name | Type | Description |
|---|---|---|
| address | TrustedInfrastructureNetworkAddress |
The service’s address. |
| cluster | string |
The opaque string identifier of the cluster in which the Key Provider Service is part of. |
| group | string |
The group ID determines which Attestation Service instances this Key Provider Service can communicate with. |
| host | string |
The trusted ESX on which the service runs. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: HostSystem. When operations return a value of this structure as a result, the field will be an identifier for the resource type: HostSystem. |
| trusted_CA | TrustedInfrastructureX509CertChain |
The service’s TLS certificate chain. |
Errors
| Code | Returns | Description |
|---|---|---|
| 401 | Error | com.vmware.vapi.std.errors.unauthenticated : if the user can not be authenticated. |
| 404 | Error | com.vmware.vapi.std.errors.error : if service's TLS certificate chain is not valid. | com.vmware.vapi.std.errors.not_found : if host doesn't match to any Host. | com.vmware.vapi.std.errors.resource_inaccessible : if connection to host failed. |
| default | Error | Not available |
