Application Resource Manager API#

Download the Application Resource Manager API in OpenAPI YAML format

GET /v1/projects/{projectName}/resource/endpoints/applications/{appId}/clusters/{clusterId}#

ListAppEndpoints

Gets a list of all endpoints for an application of a deployment in a cluster.

Parameters:

  • appId (string) – Application ID

  • clusterId (string) – Cluster ID

  • projectName (string) – unique projectName for the resource

Status Codes:
GET /v1/projects/{projectName}/resource/workloads/applications/{appId}/clusters/{clusterId}#

ListAppWorkloads

Gets a list of all workloads for an application of a deployment in a cluster.

Parameters:

  • appId (string) – Application ID

  • clusterId (string) – Cluster ID

  • projectName (string) – unique projectName for the resource

Status Codes:
PUT /v1/projects/{projectName}/resource/workloads/applications/{appId}/clusters/{clusterId}/virtual-machines/{virtualMachineId}/restart#

RestartVirtualMachine

Restarts a virtual machine for an application of a deployment in a cluster.

Parameters:

  • appId (string) – Application ID

  • clusterId (string) – Cluster ID

  • virtualMachineId (string) – Virtual machine ID

  • projectName (string) – unique projectName for the resource

Status Codes:
PUT /v1/projects/{projectName}/resource/workloads/applications/{appId}/clusters/{clusterId}/virtual-machines/{virtualMachineId}/start#

StartVirtualMachine

Starts a virtual machine for an application of a deployment in a cluster.

Parameters:

  • appId (string) – Application ID

  • clusterId (string) – Cluster ID

  • virtualMachineId (string) – Virtual machine ID

  • projectName (string) – unique projectName for the resource

Status Codes:
PUT /v1/projects/{projectName}/resource/workloads/applications/{appId}/clusters/{clusterId}/virtual-machines/{virtualMachineId}/stop#

StopVirtualMachine

Stops a virtual machine for an application of a deployment in a cluster.

Parameters:

  • appId (string) – Application ID

  • clusterId (string) – Cluster ID

  • virtualMachineId (string) – Virtual machine ID

  • projectName (string) – unique projectName for the resource

Status Codes:
GET /v1/projects/{projectName}/resource/workloads/applications/{appId}/clusters/{clusterId}/virtual-machines/{virtualMachineId}/vnc#

GetVNC

Accesses the VNC console to access a virtual machine.

Parameters:

  • appId (string) – Application ID

  • clusterId (string) – Cluster ID

  • virtualMachineId (string) – Virtual machine ID

  • projectName (string) – unique projectName for the resource

Status Codes:
PUT /v1/projects/{projectName}/resource/workloads/pods/clusters/{clusterId}/namespaces/{namespace}/pods/{podName}/delete#

DeletePod

Deletes the pod for an application in a cluster.

Parameters:

  • clusterId (string) – Cluster ID

  • namespace (string) – Namespace that the pod is running on.

  • podName (string) – Name of the pod.

  • projectName (string) – unique projectName for the resource

Status Codes: