GMI Cloud Images API

GMI Image management APIs for query OS images.

Business capability
IT Infrastructure Management BC-600.50

Operations 2

GET /v1/images/{id} Get image by ID #
GET /v1/images List images #

Specifications

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/gmi-cloud/json-schema/gmi-cloud-containers-resp-schema.json
📊
JSONSchema
https://artifacts.apis.io/gmi-cloud/json-schema/gmi-cloud-baremetal-resp-schema.json
📊
JSONSchema
https://artifacts.apis.io/gmi-cloud/json-schema/gmi-cloud-container-config-schema.json
📊
JSONSchema
https://artifacts.apis.io/gmi-cloud/json-schema/gmi-cloud-baremetal-req-schema.json
📊
JSONSchema
https://artifacts.apis.io/gmi-cloud/json-schema/gmi-cloud-firewall-resp-schema.json
📊
JSONSchema
https://artifacts.apis.io/gmi-cloud/json-schema/gmi-cloud-elastic-ipresp-schema.json
📊
JSONSchema
https://artifacts.apis.io/gmi-cloud/json-schema/gmi-cloud-update-password-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/gmi-cloud/json-schema/gmi-cloud-create-api-key-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/gmi-cloud/json-schema/gmi-cloud-create-oauth-auth-token-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/gmi-cloud/json-schema/gmi-cloud-create-session-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/gmi-cloud/json-schema/gmi-cloud-exchange-authorization-code-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/gmi-cloud/json-schema/gmi-cloud-auth-token-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/gmi-cloud/json-schema/gmi-cloud-create-template-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/gmi-cloud/json-schema/gmi-cloud-sandbox-exec-result-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/gmi-cloud/json-schema/gmi-cloud-create-sandbox-control-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/gmi-cloud/json-schema/gmi-cloud-build-definition-schema.json
📊
JSONSchema
https://artifacts.apis.io/gmi-cloud/json-schema/gmi-cloud-set-sandbox-control-timeout-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/gmi-cloud/json-schema/gmi-cloud-update-template-request-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/gmi-cloud:gmi-cloud-images-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

gmi-cloud-images-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  contact:
    email: support@gmicloud.ai
  description: Cluster Engine API spec
  title: Cluster Engine Images API
  version: 2.4.0
  x-harvested-from: Mintlify per-page OpenAPI slices on docs.gmicloud.ai/api-reference (llms.txt index), merged 2026-10-13
servers:
- url: https://console.gmicloud.ai/api
security:
- bearerAuth: []
tags:
- name: Images
  description: GMI Image management APIs for query OS images.
paths:
  /v1/images/{id}:
    get:
      tags:
      - Images
      summary: Get image by ID
      operationId: getImage
      parameters:
      - in: path
        name: id
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImageResp'
          description: successful
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      x-source: https://docs.gmicloud.ai/api-reference/images/get-image-by-id.md
  /v1/images:
    get:
      tags:
      - Images
      summary: List images
      operationId: listImages
      parameters:
      - in: query
        name: idc
        schema:
          $ref: '#/components/schemas/idcName'
      - in: query
        name: product
        schema:
          $ref: '#/components/schemas/productName'
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ImageResp'
                type: array
          description: successful
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      x-source: https://docs.gmicloud.ai/api-reference/images/list-images.md
components:
  schemas:
    ImageCreateReq:
      allOf:
      - $ref: '#/components/schemas/ImageConfig'
      - properties:
          BootMode:
            $ref: '#/components/schemas/ImageBootMode'
          DefaultPartitionTable:
            items:
              $ref: '#/components/schemas/partition'
            minItems: 1
            type: array
            x-go-type: json.RawMessage
          OSArchitecture:
            type: string
          OSSeries:
            type: string
          OSVersion:
            type: string
          SystemDiskSize:
            type: string
          icon:
            format: uri
            type: string
          idc:
            $ref: '#/components/schemas/idcName'
          name:
            $ref: '#/components/schemas/name'
          orgId:
            format: uuid
            type: string
          path:
            type: string
        required:
        - idc
        - orgId
        - path
        - name
        - OSSeries
        - OSVersion
        - OSArchitecture
        - BootMode
        - SystemDiskSize
        - DefaultPartitionTable
        - icon
        type: object
    ImageBootMode:
      enum:
      - UEFI
      - Legacy
      type: string
    name:
      maxLength: 255
      pattern: ^([A-Za-z0-9][A-Za-z0-9_\-. ]*)?[A-Za-z0-9]$
      type: string
    errorStatusMessage:
      example:
        code: 0
        group: request
        validationDetail:
        - expression: required
          field: userName
          originalValue: ''
          reason: This field is required.
      properties:
        code:
          description: The substatus error code for the API response.
          type: integer
        group:
          description: API function group. Will be "request" if there are invalid request parameters.
          type: string
        message:
          description: The substatus error message for the API response.
          type: string
        traces:
          description: The original error messages.
          items:
            type: string
          type: array
        validationDetail:
          items:
            $ref: '#/components/schemas/validationDetail'
          type: array
      required:
      - group
      - code
      type: object
    ImageConfig:
      properties:
        supportedProducts:
          items:
            $ref: '#/components/schemas/productName'
          type: array
          x-go-type: pq.StringArray
          x-go-type-import:
            path: github.com/lib/pq
      required:
      - supportedProducts
      type: object
    idcName:
      maxLength: 50
      pattern: ^[a-zA-Z0-9._-]+$
      type: string
    error:
      properties:
        code:
          type: integer
          x-go-type-skip-optional-pointer: true
        reason:
          type: string
          x-go-type-skip-optional-pointer: true
      required:
      - reason
      type: object
    validationDetail:
      example:
        expression: required
        field: userName
        originalValue: ''
        reason: This field is required.
      properties:
        argument:
          description: Data supporting the expression.
          type: string
        expression:
          description: The form of violation.
          type: string
        field:
          description: The field of the request data.
          type: string
        originalValue:
          description: The original value from the request.
          type: string
        reason:
          description: The reason for the validation error.
          type: string
      type: object
    partition:
      properties:
        fileSystem:
          maxLength: 256
          minLength: 1
          type: string
        mountPoint:
          maxLength: 1024
          minLength: 1
          type: string
        name:
          $ref: '#/components/schemas/name'
        size:
          maxLength: 256
          minLength: 1
          type: string
      required:
      - name
      - mountPoint
      - size
      - fileSystem
      type: object
    ImageResp:
      allOf:
      - $ref: '#/components/schemas/ImageCreateReq'
      - properties:
          createdAt:
            format: date-time
            type: string
          id:
            format: uuid
            type: string
          type:
            enum:
            - Public
            - Customized
            type: string
            x-enumNames:
            - ImageTypePublic
            - ImageTypeCustomized
        required:
        - id
        - type
        - createdAt
        type: object
    productName:
      maxLength: 256
      pattern: ^[a-zA-Z0-9._-]+$
      type: string
  responses:
    NotFound:
      content:
        application/json:
          example:
            reason: resource 12345678-1234-2234-3234-xxxxxxxxxxxxxx was not found
          schema:
            $ref: '#/components/schemas/error'
      description: The specified resource was not found
    ServiceUnavailable:
      content:
        application/json:
          example:
            reason: database is unavailable
          schema:
            $ref: '#/components/schemas/error'
      description: a dependent service is unavailable
    Unauthorized:
      content:
        application/json:
          examples:
            Expired access token.:
              summary: Expired access token.
              value:
                code: 1
                group: auth_verify
                message: Expired access token.
            Invalid access token.:
              summary: Invalid access token.
              value:
                code: 0
                group: auth_verify
                message: Invalid access token.
          schema:
            $ref: '#/components/schemas/errorStatusMessage'
      description: Authentication information is missing or invalid
      headers:
        WWW_Authenticate:
          schema:
            type: string
    InternalServerError:
      content:
        application/json:
          example:
            reason: An error occurred in the kubernetes cluster
          schema:
            $ref: '#/components/schemas/error'
      description: Internal Server Error
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      scheme: bearer
      type: http
x-provenance:
  method: harvested
  publisher: GMI Cloud
  source: https://docs.gmicloud.ai/api-spec/service_api.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)