Method: singleTenantHsmInstances.list

Full name: projects.locations.singleTenantHsmInstances.list

Lists SingleTenantHsmInstances.

HTTP request


GET https://cloudkms.googleapis.com/v1/{parent=projects/*/locations/*}/singleTenantHsmInstances

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The resource name of the location associated with the SingleTenantHsmInstances to list, in the format projects/*/locations/*.

Query parameters

Parameters
pageSize

integer

Optional. Optional limit on the number of SingleTenantHsmInstances to include in the response. Further SingleTenantHsmInstances can subsequently be obtained by including the ListSingleTenantHsmInstancesResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
pageToken

string

Optional. Optional pagination token, returned earlier via ListSingleTenantHsmInstancesResponse.next_page_token.
filter

string

Optional. Only include resources that match the filter in the response. For more information, see Sorting and filtering list results.
orderBy

string

Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, see Sorting and filtering list results.
showDeleted

boolean

Optional. If set to true, HsmManagement.ListSingleTenantHsmInstances will also return SingleTenantHsmInstances in DELETED state.

Request body

The request body must be empty.

Response body

Response message for HsmManagement.ListSingleTenantHsmInstances.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "singleTenantHsmInstances": [
    {
      object (SingleTenantHsmInstance)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Fields
singleTenantHsmInstances[]

object (SingleTenantHsmInstance)

The list of SingleTenantHsmInstances.
nextPageToken

string

A token to retrieve next page of results. Pass this value in ListSingleTenantHsmInstancesRequest.page_token to retrieve the next page of results.
totalSize

integer

The total number of SingleTenantHsmInstances that matched the query.

This field is not populated if ListSingleTenantHsmInstancesRequest.filter is applied.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloudkms
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • cloudkms.singleTenantHsmInstances.list

For more information, see the IAM documentation.