GMI Cloud Vpcs API

openapi: 3.2.0
info:
  contact:
    email: support@gmicloud.ai
  description: Cluster Engine API spec
  title: Cluster Engine Vpcs 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: VPCs
paths:
  /v1/vpcs:
    post:
      tags:
      - VPCs
      summary: Allocate default VPC for organization in IDC
      operationId: allocateDefaultVpc
      requestBody:
        content:
          application/json:
            schema:
              properties:
                idc:
                  $ref: '#/components/schemas/idcName'
              required:
              - idc
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/vpc'
          description: successful
      x-source: https://docs.gmicloud.ai/api-reference/vpcs/allocate-default-vpc-for-organization-in-idc.md
    get:
      tags:
      - VPCs
      summary: List all VPCs
      operationId: listVpcs
      parameters:
      - in: query
        name: idc
        schema:
          $ref: '#/components/schemas/idcName'
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/vpc'
                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/vpcs/list-all-vpcs.md
  /v1/vpcs/{id}:
    get:
      tags:
      - VPCs
      summary: Get VPC
      operationId: getVpc
      parameters:
      - in: path
        name: id
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/vpc'
          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/vpcs/get-vpc.md
    delete:
      tags:
      - VPCs
      summary: Release default VPC
      operationId: releaseDefaultVpc
      parameters:
      - in: path
        name: id
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          $ref: '#/components/responses/Done'
        '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/vpcs/release-default-vpc.md
components:
  schemas:
    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
    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
    vpc:
      properties:
        createdAt:
          format: date-time
          type: string
        id:
          format: uuid
          type: string
        idc:
          type: string
        name:
          type: string
        orgId:
          format: uuid
          type: string
        subnets:
          items:
            $ref: '#/components/schemas/vpcSubnet'
          type: array
      required:
      - id
      - idc
      - orgId
      - name
      - createdAt
      - subnets
      type: object
    vpcSubnet:
      properties:
        cidr:
          type: string
        id:
          format: uuid
          type: string
        name:
          type: string
      required:
      - id
      - name
      - cidr
      type: object
  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
    Done:
      content:
        application/json:
          example:
            result: container 12345678-1234-2234-3234-xxxxxxxxxxxxxx has been restarted
          schema:
            properties:
              result:
                type: string
            required:
            - result
            type: object
      description: An action completed successfully
    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)