Cluster Director API

The Cluster Director API lets you deploy, manage, and monitor clusters that run artificial intelligence (AI), machine learning (ML), or high performance computing (HPC) workloads.

Service: hypercomputecluster.googleapis.com

To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery documents:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://hypercomputecluster.googleapis.com

Regional service endpoint

A regional service endpoint is a base URL that specifies the network address of an API service in a single region. A service that is available in multiple regions might have multiple regional endpoints. Select a location to see its regional service endpoint for this service.


  • https://hypercomputecluster.us-east1.rep.googleapis.com

    • REST Resource: v1beta.projects.locations

    Methods
    get GET /v1beta/{name=projects/*/locations/*}
    Gets information about a location.
    list GET /v1beta/{name=projects/*}/locations
    Lists information about the supported locations for this service.

    REST Resource: v1beta.projects.locations.clusters

    Methods
    create POST /v1beta/{parent=projects/*/locations/*}/clusters
    Creates a new Cluster in a given project and location.
    delete DELETE /v1beta/{name=projects/*/locations/*/clusters/*}
    Deletes a single Cluster.
    get GET /v1beta/{name=projects/*/locations/*/clusters/*}
    Gets details of a single Cluster.
    list GET /v1beta/{parent=projects/*/locations/*}/clusters
    Lists Clusters in a given project and location.
    patch PATCH /v1beta/{cluster.name=projects/*/locations/*/clusters/*}
    Updates the parameters of a single Cluster.

    REST Resource: v1beta.projects.locations.operations

    Methods
    cancel POST /v1beta/{name=projects/*/locations/*/operations/*}:cancel
    Starts asynchronous cancellation on a long-running operation.
    delete DELETE /v1beta/{name=projects/*/locations/*/operations/*}
    Deletes a long-running operation.
    get GET /v1beta/{name=projects/*/locations/*/operations/*}
    Gets the latest state of a long-running operation.
    list GET /v1beta/{name=projects/*/locations/*}/operations
    Lists operations that match the specified filter in the request.

    REST Resource: v1.projects.locations

    Methods
    get GET /v1/{name=projects/*/locations/*}
    Gets information about a location.
    list GET /v1/{name=projects/*}/locations
    Lists information about the supported locations for this service.

    REST Resource: v1.projects.locations.clusters

    Methods
    create POST /v1/{parent=projects/*/locations/*}/clusters
    Creates a new Cluster in a given project and location.
    delete DELETE /v1/{name=projects/*/locations/*/clusters/*}
    Deletes a single Cluster.
    get GET /v1/{name=projects/*/locations/*/clusters/*}
    Gets details of a single Cluster.
    list GET /v1/{parent=projects/*/locations/*}/clusters
    Lists Clusters in a given project and location.
    patch PATCH /v1/{cluster.name=projects/*/locations/*/clusters/*}
    Updates the parameters of a single Cluster.

    REST Resource: v1.projects.locations.operations

    Methods
    cancel POST /v1/{name=projects/*/locations/*/operations/*}:cancel
    Starts asynchronous cancellation on a long-running operation.
    delete DELETE /v1/{name=projects/*/locations/*/operations/*}
    Deletes a long-running operation.
    get GET /v1/{name=projects/*/locations/*/operations/*}
    Gets the latest state of a long-running operation.
    list GET /v1/{name=projects/*/locations/*}/operations
    Lists operations that match the specified filter in the request.