PHphala
CVMs

List CVMs

Changed on

Returns CVMs in current workspace.

get/api/v1/cvms

Request

Query parameters

family'all' | 'cpu' | 'gpu'

Filter by instance family

instance_typesstring[] nullable

Filter by one or more instance type IDs

Response

List of CVM summaries

OR

Example response

[
  {
    "managed_user": {
      "id": "usr_0123abcd"
    },
    "project_id": "prj_0123abcd",
    "kms_info": {
      "id": "kms_0123abcd"
    }
  }
]

Changes

  • c71a8dc90391Revision changes
    • warning

      deleted the query request parameter teepod_id

    • warning

      deleted the query request parameter user_id

    • info

      the endpoint scheme security APIKeyHeader was removed from the API

    • info

      added the new optional query request parameter family

    • info

      added the new optional query request parameter instance_types

    • info

      added subschema #1 subschema #2 to the response body anyOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response body anyOf list for the response status