Method: projects.locations.privateClouds.hcxActivationKeys.list

Lists HcxActivationKey resources in a given private cloud.

HTTP request

GET https://vmwareengine.googleapis.com/v1/{parent=projects/*/locations/*/privateClouds/*}/hcxActivationKeys

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The resource name of the private cloud to be queried for HCX activation keys. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1/privateClouds/my-cloud

Authorization requires the following IAM permission on the specified resource parent:

  • vmwareengine.hcxActivationKeys.list

Query parameters

Parameters
pageSize

integer

The maximum number of HCX activation keys to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.

pageToken

string

A page token, received from a previous hcxActivationKeys.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to hcxActivationKeys.list must match the call that provided the page token.

Request body

The request body must be empty.

Response body

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

Response message for VmwareEngine.ListHcxActivationKeys

JSON representation
{
  "hcxActivationKeys": [
    {
      object (HcxActivationKey)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Fields
hcxActivationKeys[]

object (HcxActivationKey)

List of HCX activation keys.

nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

unreachable[]

string

Locations that could not be reached when making an aggregated query using wildcards.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.