Cluster Director API (hypercomputecluster:v1)

2026-01-21

11 new methods | New API

Additions

    Methods
  • hypercomputecluster.projects.locations.list

      Path : v1/{+name}/locations

      Flat Path : v1/projects/{projectsId}/locations

      HTTP Method : GET

      Parameters :

        name

          Description : The resource that owns the locations collection, if applicable.

          Pattern : ^projects/[^/]+$

          Location : path

          Required : Yes

          Type : string

        filter

          Description : A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).

          Location : query

          Type : string

        pageSize

          Description : The maximum number of results to return. If not set, the service selects a default.

          Location : query

          Type : integer

          Format : int32

        pageToken

          Description : A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.

          Location : query

          Type : string

        extraLocationTypes

          Description : Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.

          Location : query

          Repeated : Yes

          Type : string

      Parameter Order : name

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

      Description : Lists information about the supported locations for this service.

  • hypercomputecluster.projects.locations.get

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}

      HTTP Method : GET

      Parameters :

        name

          Description : Resource name for the location.

          Pattern : ^projects/[^/]+/locations/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Gets information about a location.

  • hypercomputecluster.projects.locations.operations.list

      Path : v1/{+name}/operations

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations

      HTTP Method : GET

      Parameters :

        name

          Description : The name of the operation's parent resource.

          Pattern : ^projects/[^/]+/locations/[^/]+$

          Location : path

          Required : Yes

          Type : string

        filter

          Description : The standard list filter.

          Location : query

          Type : string

        pageSize

          Description : The standard list page size.

          Location : query

          Type : integer

          Format : int32

        pageToken

          Description : The standard list page token.

          Location : query

          Type : string

        returnPartialSuccess

          Description : When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.

          Location : query

          Type : boolean

      Parameter Order : name

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

      Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

  • hypercomputecluster.projects.locations.operations.get

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}

      HTTP Method : GET

      Parameters :

        name

          Description : The name of the operation resource.

          Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

  • hypercomputecluster.projects.locations.operations.delete

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}

      HTTP Method : DELETE

      Parameters :

        name

          Description : The name of the operation resource to be deleted.

          Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

  • hypercomputecluster.projects.locations.operations.cancel

      Path : v1/{+name}:cancel

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel

      HTTP Method : POST

      Parameters :

        name

          Description : The name of the operation resource to be cancelled.

          Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

  • hypercomputecluster.projects.locations.clusters.list

      Path : v1/{+parent}/clusters

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clusters

      HTTP Method : GET

      Parameters :

        parent

          Description : Required. Parent location of the clusters to list, in the format `projects/{project}/locations/{location}`.

          Pattern : ^projects/[^/]+/locations/[^/]+$

          Location : path

          Required : Yes

          Type : string

        pageSize

          Description : Optional. Maximum number of clusters to return. The service may return fewer than this value.

          Location : query

          Type : integer

          Format : int32

        pageToken

          Description : Optional. A page token received from a previous `ListClusters` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListClusters` must match the call that provided the page token.

          Location : query

          Type : string

        filter

          Description : Optional. [Filter](https://google.aip.dev/160) to apply to the returned results.

          Location : query

          Type : string

        orderBy

          Description : Optional. How to order the resulting clusters. Must be one of the following strings: * `name` * `name desc` * `create_time` * `create_time desc` If not specified, clusters will be returned in an arbitrary order.

          Location : query

          Type : string

      Parameter Order : parent

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

      Description : Lists Clusters in a given project and location.

  • hypercomputecluster.projects.locations.clusters.get

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}

      HTTP Method : GET

      Parameters :

        name

          Description : Required. Name of the cluster to retrieve, in the format `projects/{project}/locations/{location}/clusters/{cluster}`.

          Pattern : ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Gets details of a single Cluster.

  • hypercomputecluster.projects.locations.clusters.create

      Path : v1/{+parent}/clusters

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clusters

      HTTP Method : POST

      Parameters :

        parent

          Description : Required. Parent location in which the cluster should be created, in the format `projects/{project}/locations/{location}`.

          Pattern : ^projects/[^/]+/locations/[^/]+$

          Location : path

          Required : Yes

          Type : string

        clusterId

          Description : Required. ID of the cluster to create. Must conform to [RFC-1034](https://datatracker.ietf.org/doc/html/rfc1034) (lower-case, alphanumeric, and at most 63 characters).

          Location : query

          Type : string

        requestId

          Description : Optional. A unique identifier for this request. A random UUID is recommended. This request is idempotent if and only if `request_id` is provided.

          Location : query

          Type : string

      Parameter Order : parent

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

      Description : Creates a new Cluster in a given project and location.

  • hypercomputecluster.projects.locations.clusters.patch

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}

      HTTP Method : PATCH

      Parameters :

        name

          Description : Identifier. [Relative resource name](https://google.aip.dev/122) of the cluster, in the format `projects/{project}/locations/{location}/clusters/{cluster}`.

          Pattern : ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$

          Location : path

          Required : Yes

          Type : string

        updateMask

          Description : Optional. Mask specifying which fields in the cluster to update. All paths must be specified explicitly - wildcards are not supported. At least one path must be provided.

          Location : query

          Type : string

          Format : google-fieldmask

        requestId

          Description : Optional. A unique identifier for this request. A random UUID is recommended. This request is idempotent if and only if `request_id` is provided.

          Location : query

          Type : string

      Parameter Order : name

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

      Description : Updates the parameters of a single Cluster.

  • hypercomputecluster.projects.locations.clusters.delete

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}

      HTTP Method : DELETE

      Parameters :

        name

          Description : Required. Name of the cluster to delete, in the format `projects/{project}/locations/{location}/clusters/{cluster}`.

          Pattern : ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$

          Location : path

          Required : Yes

          Type : string

        requestId

          Description : Optional. A unique identifier for this request. A random UUID is recommended. This request is idempotent if and only if `request_id` is provided.

          Location : query

          Type : string

      Parameter Order : name

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

      Description : Deletes a single Cluster.