REST API - list

vcenter trusted infrastructure trusted clusters kms services: list

Returns basic information about all configured Key Provider Service instances used by this cluster. This operation was added in vSphere API 7.0.0.

Request:

HTTP request

POST https://{server}/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/kms/services

?action=query
{
    "address"[
        {
            "hostname""string",
            "port"1
        },
        {
            "hostname""string",
            "port"1
        }
    ],
    "services"[
        "obj-103",
        "obj-103"
    ],
    "trust_authority_cluster"[
        "string",
        "string"
    ],
    "group"[
        "string",
        "string"
    ]
}

Path Parameters

Name Type Description
Required
cluster string The ID of the cluster.

Body Parameters:

Name Type Description
bold = required
- filter_spec Optional. Only return services matching the filters.
-.services string[] A set of IDs by which to filter the services. This attribute was added in vSphere API 7.0.0.

Optional. If unset, the services will not be filtered by ID.When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.vcenter.trusted_infrastructure.kms.Service. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.vcenter.trusted_infrastructure.kms.Service.

-.address network_address[] The service's address. This attribute was added in vSphere API 7.0.0.

Optional. If unset, the services will not be filtered by address.

-.address[].hostname string The IP address or DNS resolvable name of the service. This attribute was added in vSphere API 7.0.0.

-.address[].port long The port of the service. This attribute was added in vSphere API 7.0.0.

Optional. If unset, port 443 will be used.

-.group string[] The group determines the Attestation Service instances this Key Provider Service can accept reports from. This attribute was added in vSphere API 7.0.0.

Optional. If unset, the services will not be filtered by group.

-.trust_authority_cluster string[] The cluster specifies the Trust Authority Cluster this Key Provider Service instance belongs to. This attribute was added in vSphere API 7.0.0.

Optional. If unset, the services will not be filtered by trustAuthorityCluster.

Response:

HTTP Status Code: 200

Response Body Structure:

[
    {
        "address"{
            "hostname""string",
            "port"1
        },
        "service""obj-103",
        "trust_authority_cluster""string",
        "group""string"
    },
    {
        "address"{
            "hostname""string",
            "port"1
        },
        "service""obj-103",
        "trust_authority_cluster""string",
        "group""string"
    }
]

Headers:

None

Type:

Name Type Description
bold = required
- summary[] basic information about all configured Key Provider Service instances used by this cluster.
-[].service string The service's unique identifier. This attribute was added in vSphere API 7.0.0.

When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.kms.Service. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.kms.Service.

-[].address network_address The service's address. This attribute was added in vSphere API 7.0.0.

-[].address.hostname string The IP address or DNS resolvable name of the service. This attribute was added in vSphere API 7.0.0.

-[].address.port long The port of the service. This attribute was added in vSphere API 7.0.0.

Optional. If unset, port 443 will be used.

-[].group string The group determines the Attestation Service instances this Key Provider Service can accept reports from. This attribute was added in vSphere API 7.0.0.

-[].trust_authority_cluster string The cluster specifies the Trust Authority Cluster this Key Provider Service belongs to. This attribute was added in vSphere API 7.0.0.

Errors:

HTTP Status Code Type Description
500 error if there is a generic error.
404 not_found if the cluster ID is invalid.
401 unauthenticated if the user can not be authenticated.