Vcenter TrustedInfrastructure TrustAuthorityHosts Kms get

Vcenter TrustedInfrastructure TrustAuthorityHosts Kms get

This operation is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.

Returns the connection info about the Key Provider Service running on the specified host.

This operation was added in vSphere API 7.0.0.0.

Returns an authorization error 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
URI
GET
https://{api_host}/api/vcenter/trusted-infrastructure/trust-authority-hosts/{host}/kms/
COPY
Path Parameters
string
host
Required

Vcenter Host id.

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

Authentication
This operation uses the following authentication methods.
Responses
200

The Vcenter TrustedInfrastructure TrustAuthorityHosts Kms Info instance which contains the information necessary to connect to the Key Provider Service.

{
    "host": "string",
    "address": {
        "hostname": "string",
        "port": 0
    },
    "group": "string",
    "cluster": "string",
    "trusted_ca": {
        "cert_chain": [
            "string"
        ]
    }
}
string
host
Required

This property is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.

The trusted ESX on which the service runs.

This property was added in vSphere API 7.0.0.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: HostSystem. When operations return a value of this schema as a response, the property will be an identifier for the resource type: HostSystem.

address
Required

This property is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.

The service's address.

This property was added in vSphere API 7.0.0.0.

string
group
Required

This property is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.

The group ID determines which Attestation Service instances this Key Provider Service can communicate with.

This property was added in vSphere API 7.0.0.0.

string
cluster
Required

This property is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.

The opaque string identifier of the cluster in which the Key Provider Service is part of.

This property was added in vSphere API 7.0.0.0.

trusted_ca
Required

This property is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.

The service's TLS certificate chain.

This property was added in vSphere API 7.0.0.0.


401

if the user can not be authenticated.

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.


404

if host doesn't match to any Host.

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"

500

Vapi Std Errors Error if service's TLS certificate chain is not valid.

Vapi Std Errors ResourceInaccessible if connection to host failed.

Returns Vapi Std Errors Error of type(s) application/json 
"Vapi Std Errors Error Object"
array of object
messages
Required

Stack of one or more localizable messages for human error consumers.

The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

object
data
Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.

Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.

The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.

Some operations will not set this property when reporting errors.

string
error_type
Required

Discriminator field to help API consumers identify the structure type.

For more information see: Vapi Std Errors Error Type.

This property was added in vSphere API 6.7.2.

Can be missing or null for compatibility with preceding implementations.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/vcenter/trusted-infrastructure/trust-authority-hosts/{host}/kms/
Deprecated
On This Page
Vcenter Operations
GET
Vcenter TrustedInfrastructure TrustAuthorityHosts Kms get
Deprecated
POST
Vcenter TrustedInfrastructure TrustAuthorityHosts Kms list
Deprecated