@leaflow/sdk 0.1.0

package/openapi/compute.yaml

@@ -0,0 +1,3540 @@
+components:
+  schemas:
+    ActOnInstanceInputBody:
+      additionalProperties: false
+      properties:
+        action:
+          enum:
+            - start
+            - stop
+            - reboot
+          type: string
+      required:
+        - action
+      type: object
+    AllocateFloatingIPInputBody:
+      additionalProperties: false
+      properties:
+        address:
+          description: 指定要申领的地址。留空时由平台自动分配
+          maxLength: 64
+          type: string
+        private_network_id:
+          format: uuid
+          type: string
+      required:
+        - private_network_id
+      type: object
+    AttachDiskInputBody:
+      additionalProperties: false
+      properties:
+        disk_id:
+          format: uuid
+          type: string
+      required:
+        - disk_id
+      type: object
+    AttachFloatingIPInputBody:
+      additionalProperties: false
+      properties:
+        floating_ip_id:
+          format: uuid
+          type: string
+      required:
+        - floating_ip_id
+      type: object
+    AttachPortInputBody:
+      additionalProperties: false
+      properties:
+        port_id:
+          format: uuid
+          type: string
+      required:
+        - port_id
+      type: object
+    BindFloatingIPInputBody:
+      additionalProperties: false
+      properties:
+        port_id:
+          format: uuid
+          type: string
+      required:
+        - port_id
+      type: object
+    ConsoleOutputBody:
+      additionalProperties: false
+      properties:
+        websocket_url:
+          description: VNC 的 WebSocket 地址，一次性使用且很快失效
+          type: string
+      required:
+        - websocket_url
+      type: object
+    CreateDiskInputBody:
+      additionalProperties: false
+      properties:
+        disk_type_sku:
+          maxLength: 64
+          type: string
+        name:
+          maxLength: 128
+          type: string
+        size_gb:
+          format: int64
+          minimum: 1
+          type: integer
+        snapshot_id:
+          description: 从该快照恢复。提供时容量只需不小于快照本身
+          type: string
+      required:
+        - disk_type_sku
+        - name
+        - size_gb
+      type: object
+    CreateInstanceImageInputBody:
+      additionalProperties: false
+      properties:
+        name:
+          maxLength: 128
+          type: string
+      required:
+        - name
+      type: object
+    CreateInstanceImageOutputBody:
+      additionalProperties: false
+      properties:
+        image_id:
+          description: 新建镜像的 id。该镜像尚未上架为可售镜像
+          type: string
+      required:
+        - image_id
+      type: object
+    CreatePortInputBody:
+      additionalProperties: false
+      properties:
+        name:
+          maxLength: 128
+          type: string
+        private_ip:
+          description: 指定私网地址。留空时自动分配
+          maxLength: 64
+          type: string
+        security_group_ids:
+          description: 至少一个，且必须属于同一个私有网络
+          items:
+            type: string
+          minItems: 1
+          type:
+            - array
+            - "null"
+        subnet_id:
+          format: uuid
+          type: string
+      required:
+        - subnet_id
+        - security_group_ids
+      type: object
+    CreatePrivateNetworkInputBody:
+      additionalProperties: false
+      properties:
+        cidr:
+          description: 必须是 RFC1918 的私有网段，掩码在 /8 到 /24 之间，例如 10.0.0.0/16
+          maxLength: 32
+          type: string
+        name:
+          maxLength: 128
+          type: string
+        region_code:
+          maxLength: 32
+          type: string
+      required:
+        - name
+        - region_code
+        - cidr
+      type: object
+    CreateRouteInputBody:
+      additionalProperties: false
+      properties:
+        description:
+          maxLength: 255
+          type: string
+        destination:
+          description: 目的网段。不能为 0.0.0.0/0，也不能为某个子网自身的网段
+          maxLength: 32
+          type: string
+        nexthop:
+          description: 云服务器的私网地址，必须落在该私有网络的某个子网内
+          maxLength: 64
+          type: string
+      required:
+        - destination
+        - nexthop
+      type: object
+    CreateSecurityGroupInputBody:
+      additionalProperties: false
+      properties:
+        description:
+          maxLength: 500
+          type: string
+        name:
+          maxLength: 128
+          type: string
+        private_network_id:
+          format: uuid
+          type: string
+      required:
+        - private_network_id
+        - name
+      type: object
+    CreateSecurityRuleInputBody:
+      additionalProperties: false
+      properties:
+        description:
+          maxLength: 255
+          type: string
+        direction:
+          enum:
+            - ingress
+            - egress
+          type: string
+        ethertype:
+          enum:
+            - IPv4
+            - IPv6
+          type: string
+        port_range_max:
+          description: ICMP 上这是 code（0–255），不是端口
+          format: int64
+          type:
+            - integer
+            - "null"
+        port_range_min:
+          description: ICMP 上这是 type（0–255），不是端口
+          format: int64
+          type:
+            - integer
+            - "null"
+        protocol:
+          description: 如 tcp、udp、icmp、ipv6-icmp。留空表示全部协议
+          maxLength: 16
+          type: string
+        remote_ip_prefix:
+          description: 留空等同于 0.0.0.0/0 或 ::/0
+          maxLength: 64
+          type: string
+      required:
+        - direction
+        - ethertype
+      type: object
+    CreateSnapshotInputBody:
+      additionalProperties: false
+      properties:
+        disk_id:
+          format: uuid
+          type: string
+        name:
+          maxLength: 128
+          type: string
+      required:
+        - disk_id
+        - name
+      type: object
+    CreateSubnetInputBody:
+      additionalProperties: false
+      properties:
+        cidr:
+          description: 必须落在私有网络的网段内，且不能与已有子网重叠
+          maxLength: 32
+          type: string
+        name:
+          maxLength: 128
+          type: string
+      required:
+        - name
+        - cidr
+      type: object
+    DiskTypeView:
+      additionalProperties: false
+      properties:
+        availability_zone_code:
+          type: string
+        iops_display:
+          type: string
+        max_size_gb:
+          format: int64
+          type: integer
+        media:
+          enum:
+            - ssd
+            - hdd
+            - nvme
+          type: string
+        min_size_gb:
+          format: int64
+          type: integer
+        name:
+          type: string
+        region_code:
+          type: string
+        sku:
+          type: string
+        step_gb:
+          format: int64
+          type: integer
+        throughput_display:
+          type: string
+      required:
+        - sku
+        - name
+        - media
+        - region_code
+        - availability_zone_code
+        - min_size_gb
+        - max_size_gb
+        - step_gb
+        - iops_display
+        - throughput_display
+      type: object
+    DiskTypesOutputBody:
+      additionalProperties: false
+      properties:
+        items:
+          items:
+            $ref: "#/components/schemas/DiskTypeView"
+          type:
+            - array
+            - "null"
+      required:
+        - items
+      type: object
+    DiskView:
+      additionalProperties: false
+      properties:
+        attached_instance_id:
+          type:
+            - string
+            - "null"
+        availability_zone:
+          description: 以存储服务返回的为准。挂载时云服务器必须位于同一可用区
+          type: string
+        created_at:
+          format: date-time
+          type: string
+        device:
+          description: 系统分配的设备名，在云服务器内看到的即为该名称
+          type:
+            - string
+            - "null"
+        disk_type_sku:
+          type: string
+        id:
+          format: uuid
+          type: string
+        name:
+          type: string
+        region_code:
+          type: string
+        size_gb:
+          format: int64
+          type: integer
+        status:
+          enum:
+            - provisioning
+            - available
+            - attaching
+            - in_use
+            - detaching
+            - resizing
+            - deleting
+            - error
+          type: string
+      required:
+        - id
+        - name
+        - region_code
+        - availability_zone
+        - disk_type_sku
+        - size_gb
+        - status
+        - attached_instance_id
+        - device
+        - created_at
+      type: object
+    DisksOutputBody:
+      additionalProperties: false
+      properties:
+        items:
+          items:
+            $ref: "#/components/schemas/DiskView"
+          type:
+            - array
+            - "null"
+      required:
+        - items
+      type: object
+    Error:
+      additionalProperties: false
+      properties:
+        code:
+          type: string
+        message:
+          type: string
+        meta:
+          additionalProperties: {}
+          type: object
+        status:
+          format: int64
+          type: integer
+      required:
+        - status
+        - message
+      type: object
+    FloatingIPView:
+      additionalProperties: false
+      properties:
+        address:
+          type: string
+        attached_fixed_ip:
+          type:
+            - string
+            - "null"
+        attached_port_id:
+          type:
+            - string
+            - "null"
+        bandwidth_mbps:
+          format: int64
+          type:
+            - integer
+            - "null"
+        created_at:
+          format: date-time
+          type: string
+        detached_at:
+          format: date-time
+          type:
+            - string
+            - "null"
+        id:
+          format: uuid
+          type: string
+        region_code:
+          type: string
+        status:
+          enum:
+            - available
+            - associated
+            - blackholed
+            - scrubbing
+          type: string
+      required:
+        - id
+        - region_code
+        - address
+        - status
+        - bandwidth_mbps
+        - attached_port_id
+        - attached_fixed_ip
+        - detached_at
+        - created_at
+      type: object
+    FloatingIPsOutputBody:
+      additionalProperties: false
+      properties:
+        items:
+          items:
+            $ref: "#/components/schemas/FloatingIPView"
+          type:
+            - array
+            - "null"
+      required:
+        - items
+      type: object
+    ImageView:
+      additionalProperties: false
+      properties:
+        architecture:
+          type: string
+        min_disk_gb:
+          format: int64
+          type: integer
+        min_ram_mb:
+          format: int64
+          type: integer
+        name:
+          type: string
+        os_family:
+          type: string
+        os_version:
+          type: string
+        region_code:
+          type: string
+        sku:
+          type: string
+      required:
+        - sku
+        - name
+        - os_family
+        - os_version
+        - architecture
+        - region_code
+        - min_disk_gb
+        - min_ram_mb
+      type: object
+    ImagesOutputBody:
+      additionalProperties: false
+      properties:
+        items:
+          items:
+            $ref: "#/components/schemas/ImageView"
+          type:
+            - array
+            - "null"
+      required:
+        - items
+      type: object
+    InstanceTypeView:
+      additionalProperties: false
+      properties:
+        availability_zone_code:
+          description: 该机型所属的可用区。云硬盘必须位于同一可用区才能挂载
+          type: string
+        max_bandwidth_mbps:
+          format: int64
+          type: integer
+        max_floating_ips:
+          format: int64
+          type: integer
+        max_ports:
+          format: int64
+          type: integer
+        name:
+          type: string
+        ram_mb:
+          format: int64
+          type: integer
+        region_code:
+          type: string
+        sku:
+          type: string
+        vcpus:
+          format: int64
+          type: integer
+      required:
+        - sku
+        - name
+        - vcpus
+        - ram_mb
+        - region_code
+        - availability_zone_code
+        - max_ports
+        - max_floating_ips
+        - max_bandwidth_mbps
+      type: object
+    InstanceTypesOutputBody:
+      additionalProperties: false
+      properties:
+        items:
+          items:
+            $ref: "#/components/schemas/InstanceTypeView"
+          type:
+            - array
+            - "null"
+      required:
+        - items
+      type: object
+    InstanceView:
+      additionalProperties: false
+      properties:
+        availability_zone:
+          type: string
+        created_at:
+          format: date-time
+          type: string
+        hostname:
+          description: 云服务器内的主机名，等于云服务器 id
+          type: string
+        id:
+          format: uuid
+          type: string
+        image_sku:
+          type: string
+        instance_type_sku:
+          type: string
+        name:
+          type: string
+        region_code:
+          type: string
+        status:
+          enum:
+            - provisioning
+            - running
+            - stopped
+            - rebooting
+            - resizing
+            - error
+            - deleting
+            - suspended
+          type: string
+        suspended_at:
+          description: 非空表示已被平台停服，需先解除后才能操作
+          format: date-time
+          type:
+            - string
+            - "null"
+        updated_at:
+          format: date-time
+          type: string
+      required:
+        - id
+        - name
+        - hostname
+        - region_code
+        - availability_zone
+        - instance_type_sku
+        - image_sku
+        - status
+        - suspended_at
+        - created_at
+        - updated_at
+      type: object
+    InstancesOutputBody:
+      additionalProperties: false
+      properties:
+        items:
+          items:
+            $ref: "#/components/schemas/InstanceView"
+          type:
+            - array
+            - "null"
+      required:
+        - items
+      type: object
+    Ipv6OutputBody:
+      additionalProperties: false
+      properties:
+        cidr:
+          description: 已分配的 /64 前缀，未启用时为空
+          type: string
+        enabled:
+          type: boolean
+        status:
+          description: 为 active 时表示 IPv6 已完全可用
+          enum:
+            - pending
+            - active
+            - draining
+          type: string
+      required:
+        - enabled
+        - cidr
+        - status
+      type: object
+    LaunchInstanceInputBody:
+      additionalProperties: false
+      properties:
+        generate_password:
+          description: 由平台生成随机密码，仅在本次响应中返回
+          type: boolean
+        image_sku:
+          maxLength: 64
+          type: string
+        instance_type_sku:
+          maxLength: 64
+          type: string
+        name:
+          maxLength: 128
+          type: string
+        password:
+          description: root 的登录密码。留空时仅使用项目的 SSH 公钥
+          maxLength: 128
+          type: string
+        security_group_ids:
+          description: 至少一个。不会自动使用默认安全组，需显式指定
+          items:
+            type: string
+          minItems: 1
+          type:
+            - array
+            - "null"
+        subnet_id:
+          format: uuid
+          type: string
+      required:
+        - name
+        - instance_type_sku
+        - image_sku
+        - subnet_id
+        - security_group_ids
+      type: object
+    LaunchInstanceOutputBody:
+      additionalProperties: false
+      properties:
+        instance:
+          $ref: "#/components/schemas/InstanceView"
+        password:
+          description: 只在创建时返回这一次，请立刻保存
+          type: string
+      required:
+        - instance
+        - password
+      type: object
+    NextFreeCidrOutputBody:
+      additionalProperties: false
+      properties:
+        cidr:
+          description: 为空表示该私有网络内已无满足该掩码的空闲网段
+          type: string
+      required:
+        - cidr
+      type: object
+    PortView:
+      additionalProperties: false
+      properties:
+        attached_instance_id:
+          type:
+            - string
+            - "null"
+        id:
+          format: uuid
+          type: string
+        ipv6_address:
+          type:
+            - string
+            - "null"
+        is_primary:
+          description: 主网卡随云服务器一并创建和释放，不可单独卸载
+          type: boolean
+        mac:
+          type:
+            - string
+            - "null"
+        name:
+          type: string
+        private_ip:
+          type:
+            - string
+            - "null"
+        private_network_id:
+          format: uuid
+          type: string
+        subnet_id:
+          format: uuid
+          type: string
+      required:
+        - id
+        - private_network_id
+        - subnet_id
+        - name
+        - mac
+        - is_primary
+        - attached_instance_id
+        - private_ip
+        - ipv6_address
+      type: object
+    PortsOutputBody:
+      additionalProperties: false
+      properties:
+        items:
+          items:
+            $ref: "#/components/schemas/PortView"
+          type:
+            - array
+            - "null"
+      required:
+        - items
+      type: object
+    PrivateNetworkView:
+      additionalProperties: false
+      properties:
+        cidr:
+          type: string
+        created_at:
+          format: date-time
+          type: string
+        gateway_v4:
+          description: 该私有网络出口的 v4 地址
+          type:
+            - string
+            - "null"
+        gateway_v6:
+          description: 该私有网络出口的 v6 地址，未启用 IPv6 时为空
+          type:
+            - string
+            - "null"
+        has_internet_gateway:
+          type: boolean
+        id:
+          format: uuid
+          type: string
+        name:
+          type: string
+        region_code:
+          type: string
+        status:
+          enum:
+            - available
+            - error
+          type: string
+        updated_at:
+          format: date-time
+          type: string
+      required:
+        - id
+        - name
+        - region_code
+        - cidr
+        - status
+        - has_internet_gateway
+        - gateway_v4
+        - gateway_v6
+        - created_at
+        - updated_at
+      type: object
+    PrivateNetworksOutputBody:
+      additionalProperties: false
+      properties:
+        items:
+          items:
+            $ref: "#/components/schemas/PrivateNetworkView"
+          type:
+            - array
+            - "null"
+      required:
+        - items
+      type: object
+    RebuildInstanceInputBody:
+      additionalProperties: false
+      properties:
+        generate_password:
+          type: boolean
+        image_sku:
+          maxLength: 64
+          type: string
+        password:
+          maxLength: 128
+          type: string
+      required:
+        - image_sku
+      type: object
+    RebuildInstanceOutputBody:
+      additionalProperties: false
+      properties:
+        instance:
+          $ref: "#/components/schemas/InstanceView"
+        password:
+          description: 只在这一次返回
+          type: string
+      required:
+        - instance
+        - password
+      type: object
+    RegionView:
+      additionalProperties: false
+      properties:
+        code:
+          type: string
+        country_code:
+          type: string
+        name:
+          type: string
+      required:
+        - code
+        - name
+        - country_code
+      type: object
+    RegionsOutputBody:
+      additionalProperties: false
+      properties:
+        items:
+          items:
+            $ref: "#/components/schemas/RegionView"
+          type:
+            - array
+            - "null"
+      required:
+        - items
+      type: object
+    RenameDiskInputBody:
+      additionalProperties: false
+      properties:
+        name:
+          maxLength: 128
+          type: string
+      required:
+        - name
+      type: object
+    RenameInstanceInputBody:
+      additionalProperties: false
+      properties:
+        name:
+          maxLength: 128
+          type: string
+      required:
+        - name
+      type: object
+    ResizeDiskInputBody:
+      additionalProperties: false
+      properties:
+        size_gb:
+          description: 必须大于当前容量
+          format: int64
+          minimum: 1
+          type: integer
+      required:
+        - size_gb
+      type: object
+    ResizeInstanceInputBody:
+      additionalProperties: false
+      properties:
+        instance_type_sku:
+          description: 必须与当前机型位于同一地区和可用区
+          maxLength: 64
+          type: string
+      required:
+        - instance_type_sku
+      type: object
+    RouteView:
+      additionalProperties: false
+      properties:
+        created_at:
+          format: date-time
+          type: string
+        description:
+          type: string
+        destination:
+          type: string
+        id:
+          format: uuid
+          type: string
+        nexthop:
+          type: string
+      required:
+        - id
+        - destination
+        - nexthop
+        - description
+        - created_at
+      type: object
+    RoutesOutputBody:
+      additionalProperties: false
+      properties:
+        items:
+          items:
+            $ref: "#/components/schemas/RouteView"
+          type:
+            - array
+            - "null"
+      required:
+        - items
+      type: object
+    SecurityGroupView:
+      additionalProperties: false
+      properties:
+        created_at:
+          format: date-time
+          type: string
+        description:
+          type: string
+        id:
+          format: uuid
+          type: string
+        is_default:
+          description: 默认安全组随私有网络一并释放，不可单独删除
+          type: boolean
+        name:
+          type: string
+        private_network_id:
+          format: uuid
+          type: string
+      required:
+        - id
+        - private_network_id
+        - name
+        - description
+        - is_default
+        - created_at
+      type: object
+    SecurityGroupsOutputBody:
+      additionalProperties: false
+      properties:
+        items:
+          items:
+            $ref: "#/components/schemas/SecurityGroupView"
+          type:
+            - array
+            - "null"
+      required:
+        - items
+      type: object
+    SecurityRuleView:
+      additionalProperties: false
+      properties:
+        created_at:
+          format: date-time
+          type: string
+        description:
+          type: string
+        direction:
+          enum:
+            - ingress
+            - egress
+          type: string
+        ethertype:
+          enum:
+            - IPv4
+            - IPv6
+          type: string
+        id:
+          format: uuid
+          type: string
+        port_range_max:
+          description: ICMP 协议下表示 code，而非端口
+          format: int64
+          type:
+            - integer
+            - "null"
+        port_range_min:
+          description: ICMP 协议下表示 type，而非端口
+          format: int64
+          type:
+            - integer
+            - "null"
+        protocol:
+          type:
+            - string
+            - "null"
+        remote_ip_prefix:
+          type:
+            - string
+            - "null"
+      required:
+        - id
+        - direction
+        - ethertype
+        - protocol
+        - port_range_min
+        - port_range_max
+        - remote_ip_prefix
+        - description
+        - created_at
+      type: object
+    SecurityRulesOutputBody:
+      additionalProperties: false
+      properties:
+        items:
+          items:
+            $ref: "#/components/schemas/SecurityRuleView"
+          type:
+            - array
+            - "null"
+      required:
+        - items
+      type: object
+    SetBandwidthInputBody:
+      additionalProperties: false
+      properties:
+        mbps:
+          description: 出入两个方向都会限到这个值
+          format: int64
+          minimum: 1
+          type: integer
+      required:
+        - mbps
+      type: object
+    SnapshotView:
+      additionalProperties: false
+      properties:
+        created_at:
+          format: date-time
+          type: string
+        disk_id:
+          format: uuid
+          type: string
+        id:
+          format: uuid
+          type: string
+        name:
+          type: string
+        region_code:
+          type: string
+        size_gb:
+          description: 创建快照时源云硬盘的容量。由该快照恢复的云硬盘不能小于此容量
+          format: int64
+          type: integer
+        status:
+          enum:
+            - provisioning
+            - available
+            - deleting
+            - error
+          type: string
+      required:
+        - id
+        - disk_id
+        - name
+        - size_gb
+        - status
+        - region_code
+        - created_at
+      type: object
+    SnapshotsOutputBody:
+      additionalProperties: false
+      properties:
+        items:
+          items:
+            $ref: "#/components/schemas/SnapshotView"
+          type:
+            - array
+            - "null"
+      required:
+        - items
+      type: object
+    SubnetView:
+      additionalProperties: false
+      properties:
+        cidr:
+          type: string
+        gateway_ip:
+          type:
+            - string
+            - "null"
+        id:
+          format: uuid
+          type: string
+        ip_version:
+          enum:
+            - 4
+            - 6
+          format: int64
+          type: integer
+        name:
+          type: string
+        private_network_id:
+          format: uuid
+          type: string
+      required:
+        - id
+        - private_network_id
+        - name
+        - ip_version
+        - cidr
+        - gateway_ip
+      type: object
+    SubnetsOutputBody:
+      additionalProperties: false
+      properties:
+        items:
+          items:
+            $ref: "#/components/schemas/SubnetView"
+          type:
+            - array
+            - "null"
+      required:
+        - items
+      type: object
+    ZoneView:
+      additionalProperties: false
+      properties:
+        code:
+          type: string
+        name:
+          type: string
+      required:
+        - code
+        - name
+      type: object
+    ZonesOutputBody:
+      additionalProperties: false
+      properties:
+        items:
+          items:
+            $ref: "#/components/schemas/ZoneView"
+          type:
+            - array
+            - "null"
+      required:
+        - items
+      type: object
+info:
+  description: |-
+    用户自己用的接口：云服务器、云硬盘、快照、私有网络、子网、路由、安全组、网卡、公网 IP。
+
+    ## 怎么带身份
+
+    每个请求都要带 `Authorization: Bearer <项目令牌>`。先在 auth.leaflow.net 登录拿到账号令牌，再用它向 IAM 换取项目令牌（`POST /api/v1/projects/{projectId}/token`）。一张项目令牌同时说明当前用户和当前项目。
+
+    **路径和请求头上都没有 `project_id`**：当前项目由令牌决定。
+
+    失败时按出路区分：`IDENTITY_EXPIRED` 表示令牌过期，重新换取即可，无需重新登录；`PROJECT_FORBIDDEN` 表示当前账号不是该项目成员；`PROJECT_UNAVAILABLE` 表示项目欠费或正在删除；`PROJECT_NOT_WRITABLE` 表示项目仍可访问但不再接受写入。
+
+    **欠费停服的项目仍然可以删除资源。** 新建和修改会返回 `PROJECT_NOT_WRITABLE`，`DELETE` 照常放行——云硬盘和公网 IP 在停服期间仍然计费，删除是止损手段。
+
+    ## 通用约定
+
+    - **操作是异步的。** 创建云服务器、创建云硬盘、变更配置在返回时尚未完成，资源处于 `provisioning` 等中间状态，需轮询 GET 确认结果。查询单个资源时会同步一次当前状态。
+    - **可用区。** 云硬盘与云服务器必须位于同一可用区才能挂载。机型和硬盘类型各自绑定在一个可用区上，选定类型即选定可用区。
+    - **IPv6 不单独售卖。** IPv6 地址通过 SLAAC 下发到网卡，启用 IPv6 是私有网络上的一个开关，而非一次购买。
+    - **公网 IP 有冷却期。** 释放后短时间内既不能重新申领，也不会分配给其他用户，以免仍指向该地址的 DNS 记录和访问白名单立即失效。
+    - **密码只返回一次。** 创建或重装时若由平台生成密码，它仅出现在该次响应中，请及时保存。
+  title: Leaflow 计算用户 API
+  version: 1.0.0
+openapi: 3.1.0
+paths:
+  /api/v1/disk-types:
+    get:
+      operationId: list-disk-types
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - explode: false
+          in: query
+          name: region_code
+          required: true
+          schema:
+            maxLength: 32
+            type: string
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/DiskTypesOutputBody"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 列出在售硬盘类型
+      tags:
+        - Catalog
+  /api/v1/disks:
+    get:
+      description: 同时提供 region_code 与 availability_zone 时，只返回可挂载到该位置云服务器的云硬盘。
+      operationId: list-disks
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - explode: false
+          in: query
+          name: region_code
+          schema:
+            maxLength: 32
+            type: string
+        - description: 与 region_code 同时提供，用于筛选可挂载的云硬盘
+          explode: false
+          in: query
+          name: availability_zone
+          schema:
+            description: 与 region_code 同时提供，用于筛选可挂载的云硬盘
+            maxLength: 64
+            type: string
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/DisksOutputBody"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 列出云硬盘
+      tags:
+        - Disk
+    post:
+      description: 云硬盘创建在所选硬盘类型所属的可用区，云服务器必须位于同一可用区才能挂载。因此选定硬盘类型即确定了可用区。
+      operationId: create-disk
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/CreateDiskInputBody"
+        required: true
+      responses:
+        "201":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/DiskView"
+          description: Created
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 创建云硬盘
+      tags:
+        - Disk
+  /api/v1/disks/{diskId}:
+    delete:
+      description: 云硬盘仍处于挂载状态，或仍存在快照时，删除会被拒绝。
+      operationId: delete-disk
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: diskId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      responses:
+        "204":
+          description: No Content
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 删除云硬盘
+      tags:
+        - Disk
+    get:
+      description: 会同步一次底层的当前状态，因此比列表接口慢但更准确。
+      operationId: get-disk
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: diskId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/DiskView"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 查看云硬盘
+      tags:
+        - Disk
+    patch:
+      description: 仅可修改名称。容量请使用扩容接口，类型与可用区不可修改。
+      operationId: rename-disk
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: diskId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/RenameDiskInputBody"
+        required: true
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/DiskView"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 重命名云硬盘
+      tags:
+        - Disk
+  /api/v1/disks/{diskId}/resize:
+    post:
+      description: 容量只能增加，不支持缩容。扩容完成后需在云服务器内自行扩展文件系统。
+      operationId: resize-disk
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: diskId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/ResizeDiskInputBody"
+        required: true
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/DiskView"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 扩容
+      tags:
+        - Disk
+  /api/v1/floating-ips:
+    get:
+      operationId: list-floating-ips
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/FloatingIPsOutputBody"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 列出公网 IP
+      tags:
+        - FloatingIP
+    post:
+      description: |-
+        若该私有网络尚未连通外网，会一并为其接入外网。
+
+        IPv6 不通过本接口申请：IPv6 地址由 SLAAC 下发到网卡，启用 IPv6 是私有网络上的一个开关。
+      operationId: allocate-floating-ip
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/AllocateFloatingIPInputBody"
+        required: true
+      responses:
+        "201":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/FloatingIPView"
+          description: Created
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 申领公网 IP
+      tags:
+        - FloatingIP
+  /api/v1/floating-ips/{floatingIpId}:
+    delete:
+      description: 地址释放后进入冷却期才会重新分配，以免仍指向它的 DNS 记录和访问白名单立即失效。因此释放后的短时间内**无法重新申领同一个地址**，请谨慎操作。
+      operationId: release-floating-ip
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: floatingIpId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      responses:
+        "204":
+          description: No Content
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 释放公网 IP
+      tags:
+        - FloatingIP
+    get:
+      operationId: get-floating-ip
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: floatingIpId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/FloatingIPView"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 查看公网 IP
+      tags:
+        - FloatingIP
+  /api/v1/floating-ips/{floatingIpId}/bandwidth:
+    put:
+      description: 出入两个方向同时限速。仅限制出方向无法防止入方向流量打满上联带宽。
+      operationId: set-floating-ip-bandwidth
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: floatingIpId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/SetBandwidthInputBody"
+        required: true
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/FloatingIPView"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 设带宽上限
+      tags:
+        - FloatingIP
+  /api/v1/floating-ips/{floatingIpId}/binding:
+    delete:
+      description: 地址仍归本项目持有，只是不再指向任何网卡。
+      operationId: unbind-floating-ip
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: floatingIpId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/FloatingIPView"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 解绑公网 IP
+      tags:
+        - FloatingIP
+    put:
+      operationId: bind-floating-ip
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: floatingIpId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/BindFloatingIPInputBody"
+        required: true
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/FloatingIPView"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 将公网 IP 绑定到网卡
+      tags:
+        - FloatingIP
+  /api/v1/images:
+    get:
+      description: min_ram_mb 超过所选机型内存的镜像无法启动，请据此过滤可选项。
+      operationId: list-images
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - explode: false
+          in: query
+          name: region_code
+          required: true
+          schema:
+            maxLength: 32
+            type: string
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ImagesOutputBody"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 列出在售镜像
+      tags:
+        - Catalog
+  /api/v1/instance-types:
+    get:
+      operationId: list-instance-types
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - explode: false
+          in: query
+          name: region_code
+          required: true
+          schema:
+            maxLength: 32
+            type: string
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/InstanceTypesOutputBody"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 列出在售机型
+      tags:
+        - Catalog
+  /api/v1/instances:
+    get:
+      operationId: list-instances
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/InstancesOutputBody"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 列出云服务器
+      tags:
+        - Instance
+    post:
+      description: |-
+        **必须提供一种登录方式**：项目上已有 SSH 公钥，或在请求中设置密码。两者都没有时请求会被拒绝，否则创建出的云服务器将无法登录。
+
+        云服务器创建在机型所属的可用区。后续要挂载的云硬盘必须位于同一可用区。
+
+        接口返回时创建尚未完成（status 为 provisioning），请轮询 GET 确认结果。
+      operationId: launch-instance
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/LaunchInstanceInputBody"
+        required: true
+      responses:
+        "201":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/LaunchInstanceOutputBody"
+          description: Created
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 创建云服务器
+      tags:
+        - Instance
+  /api/v1/instances/{instanceId}:
+    delete:
+      description: 系统盘随云服务器一并删除。数据盘会被卸载并保留。主网卡随云服务器一并释放。
+      operationId: delete-instance
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: instanceId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      responses:
+        "204":
+          description: No Content
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 释放云服务器
+      tags:
+        - Instance
+    get:
+      description: 会同步一次底层的当前状态，因此比列表接口慢但更准确。轮询创建进度请使用本接口。
+      operationId: get-instance
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: instanceId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/InstanceView"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 查看云服务器
+      tags:
+        - Instance
+    patch:
+      description: 仅修改显示名称。云服务器内的主机名不变，它等于云服务器 id。
+      operationId: rename-instance
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: instanceId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/RenameInstanceInputBody"
+        required: true
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/InstanceView"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 重命名云服务器
+      tags:
+        - Instance
+  /api/v1/instances/{instanceId}/actions:
+    post:
+      description: 重启为软重启，由操作系统正常关闭后重新启动。已被平台停服的云服务器需先解除停服。
+      operationId: act-on-instance
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: instanceId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/ActOnInstanceInputBody"
+        required: true
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/InstanceView"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 开机、关机、重启
+      tags:
+        - Instance
+  /api/v1/instances/{instanceId}/console:
+    post:
+      description: 返回的地址一次性使用，数分钟后失效。**请勿缓存**，每次使用前重新获取。
+      operationId: open-instance-console
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: instanceId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ConsoleOutputBody"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 打开 VNC 控制台
+      tags:
+        - Instance
+  /api/v1/instances/{instanceId}/disks:
+    get:
+      operationId: list-instance-disks
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: instanceId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/DisksOutputBody"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 列出云服务器已挂载的云硬盘
+      tags:
+        - Attachment
+    post:
+      description: 云硬盘必须与云服务器位于同一地区和可用区。挂载后需在云服务器内自行分区并挂载文件系统。
+      operationId: attach-disk
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: instanceId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/AttachDiskInputBody"
+        required: true
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/DiskView"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 挂载云硬盘
+      tags:
+        - Attachment
+  /api/v1/instances/{instanceId}/disks/{diskId}:
+    delete:
+      description: 请先在云服务器内卸载（umount）该设备再调用本接口，正在写入的文件系统被强制卸载会损坏数据。
+      operationId: detach-disk
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: instanceId
+          required: true
+          schema:
+            format: uuid
+            type: string
+        - in: path
+          name: diskId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/DiskView"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 卸载云硬盘
+      tags:
+        - Attachment
+  /api/v1/instances/{instanceId}/floating-ips:
+    post:
+      description: 公网 IP 绑定在云服务器的主网卡上。
+      operationId: attach-instance-floating-ip
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: instanceId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/AttachFloatingIPInputBody"
+        required: true
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/FloatingIPView"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 为云服务器绑定公网 IP
+      tags:
+        - Attachment
+  /api/v1/instances/{instanceId}/floating-ips/{floatingIpId}:
+    delete:
+      operationId: detach-instance-floating-ip
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: instanceId
+          required: true
+          schema:
+            format: uuid
+            type: string
+        - in: path
+          name: floatingIpId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/FloatingIPView"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 解绑云服务器的公网 IP
+      tags:
+        - Attachment
+  /api/v1/instances/{instanceId}/image:
+    post:
+      description: 创建出的镜像不会自动上架，仅归本项目所有。
+      operationId: create-instance-image
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: instanceId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/CreateInstanceImageInputBody"
+        required: true
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/CreateInstanceImageOutputBody"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 将云服务器创建为镜像
+      tags:
+        - Instance
+  /api/v1/instances/{instanceId}/ports:
+    get:
+      operationId: list-instance-ports
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: instanceId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/PortsOutputBody"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 列出云服务器的网卡
+      tags:
+        - Attachment
+    post:
+      operationId: attach-port
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: instanceId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/AttachPortInputBody"
+        required: true
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/PortView"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 挂载网卡
+      tags:
+        - Attachment
+  /api/v1/instances/{instanceId}/ports/{portId}:
+    delete:
+      description: 主网卡不可卸载，卸载后云服务器将失去网络地址。
+      operationId: detach-port
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: instanceId
+          required: true
+          schema:
+            format: uuid
+            type: string
+        - in: path
+          name: portId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/PortView"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 卸载网卡
+      tags:
+        - Attachment
+  /api/v1/instances/{instanceId}/rebuild:
+    post:
+      description: "**系统盘数据将被清除且无法恢复。** 数据盘不受影响。"
+      operationId: rebuild-instance
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: instanceId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/RebuildInstanceInputBody"
+        required: true
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/RebuildInstanceOutputBody"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 重装系统
+      tags:
+        - Instance
+  /api/v1/instances/{instanceId}/resize:
+    post:
+      description: |-
+        只能变更为同一地区、同一可用区的机型，否则已挂载的云硬盘无法随之迁移。
+
+        变配后需调用确认接口才算完成；未确认时原规格占用的资源不会释放。
+      operationId: resize-instance
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: instanceId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/ResizeInstanceInputBody"
+        required: true
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/InstanceView"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 变配
+      tags:
+        - Instance
+  /api/v1/instances/{instanceId}/resize/confirm:
+    post:
+      operationId: confirm-instance-resize
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: instanceId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/InstanceView"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 确认变配
+      tags:
+        - Instance
+  /api/v1/instances/{instanceId}/resize/revert:
+    post:
+      operationId: revert-instance-resize
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: instanceId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/InstanceView"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 回滚变配
+      tags:
+        - Instance
+  /api/v1/ports:
+    get:
+      operationId: list-ports
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/PortsOutputBody"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 列出网卡
+      tags:
+        - Port
+    post:
+      description: 创建出的网卡尚未挂载到任何云服务器。主网卡不由本接口创建，它随云服务器一并创建。
+      operationId: create-port
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/CreatePortInputBody"
+        required: true
+      responses:
+        "201":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/PortView"
+          description: Created
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 创建网卡
+      tags:
+        - Port
+  /api/v1/ports/{portId}:
+    delete:
+      description: 主网卡不可单独删除，它随云服务器一并释放。仍挂载在云服务器上的网卡也无法删除。
+      operationId: delete-port
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: portId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      responses:
+        "204":
+          description: No Content
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 删除网卡
+      tags:
+        - Port
+  /api/v1/private-networks:
+    get:
+      operationId: list-private-networks
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - description: 不传时返回全部地区
+          explode: false
+          in: query
+          name: region_code
+          schema:
+            description: 不传时返回全部地区
+            maxLength: 32
+            type: string
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/PrivateNetworksOutputBody"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 列出私有网络
+      tags:
+        - PrivateNetwork
+    post:
+      description: 同时创建一张网络、一台路由器和一个默认安全组。默认安全组拒绝全部入站流量、放行全部出站流量。
+      operationId: create-private-network
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/CreatePrivateNetworkInputBody"
+        required: true
+      responses:
+        "201":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/PrivateNetworkView"
+          description: Created
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 创建私有网络
+      tags:
+        - PrivateNetwork
+  /api/v1/private-networks/{privateNetworkId}:
+    delete:
+      description: 其中仍有云服务器或网卡时，释放会被拒绝。IPv6、路由器与安全组随之一并释放。
+      operationId: delete-private-network
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: privateNetworkId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      responses:
+        "204":
+          description: No Content
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 释放私有网络
+      tags:
+        - PrivateNetwork
+    get:
+      operationId: get-private-network
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: privateNetworkId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/PrivateNetworkView"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 查看私有网络
+      tags:
+        - PrivateNetwork
+  /api/v1/private-networks/{privateNetworkId}/internet-gateway:
+    delete:
+      description: 项目中仍有已绑定的公网 IP 时会被拒绝：断开外网接入会使这些地址立即不可达。
+      operationId: detach-internet-gateway
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: privateNetworkId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/PrivateNetworkView"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 断开私有网络的外网接入
+      tags:
+        - PrivateNetwork
+    post:
+      description: 申领公网 IP 时会自动完成此步骤，通常无需单独调用。启用 IPv6 前必须先接入外网。
+      operationId: attach-internet-gateway
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: privateNetworkId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/PrivateNetworkView"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 为私有网络接入外网
+      tags:
+        - PrivateNetwork
+  /api/v1/private-networks/{privateNetworkId}/ipv6:
+    delete:
+      description: 释放的前缀不会立即重新分配。
+      operationId: disable-private-network-ipv6
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: privateNetworkId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      responses:
+        "204":
+          description: No Content
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 关闭私有网络的 IPv6
+      tags:
+        - PrivateNetwork
+    get:
+      operationId: get-private-network-ipv6
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: privateNetworkId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Ipv6OutputBody"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 查看私有网络的 IPv6
+      tags:
+        - PrivateNetwork
+    post:
+      description: |-
+        为该私有网络分配一个 /64 前缀。IPv6 地址由 SLAAC 下发到网卡，无需也无法单独申领。
+
+        前提是该私有网络已接入外网。
+      operationId: enable-private-network-ipv6
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: privateNetworkId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Ipv6OutputBody"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 为私有网络启用 IPv6
+      tags:
+        - PrivateNetwork
+  /api/v1/private-networks/{privateNetworkId}/routes:
+    get:
+      operationId: list-routes
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: privateNetworkId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/RoutesOutputBody"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 列出静态路由
+      tags:
+        - Route
+    post:
+      description: 以下三种会导致网络中断的写法会被拒绝：目的网段为 0.0.0.0/0（覆盖默认路由，所有公网 IP 立即失效）、目的网段为某个子网自身（覆盖直连路由）、下一跳为某个子网的网关（指回路由器自身）。
+      operationId: create-route
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: privateNetworkId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/CreateRouteInputBody"
+        required: true
+      responses:
+        "201":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/RouteView"
+          description: Created
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 创建静态路由
+      tags:
+        - Route
+  /api/v1/private-networks/{privateNetworkId}/routes/{routeId}:
+    delete:
+      operationId: delete-route
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: privateNetworkId
+          required: true
+          schema:
+            format: uuid
+            type: string
+        - in: path
+          name: routeId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      responses:
+        "204":
+          description: No Content
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 删除静态路由
+      tags:
+        - Route
+  /api/v1/private-networks/{privateNetworkId}/subnets:
+    get:
+      description: IPv6 子网也在返回结果中，ip_version 为 6。它在启用 IPv6 时自动创建，不可单独删除。
+      operationId: list-subnets
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: privateNetworkId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/SubnetsOutputBody"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 列出子网
+      tags:
+        - Subnet
+    post:
+      operationId: create-subnet
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: privateNetworkId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/CreateSubnetInputBody"
+        required: true
+      responses:
+        "201":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/SubnetView"
+          description: Created
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 创建子网
+      tags:
+        - Subnet
+  /api/v1/private-networks/{privateNetworkId}/subnets/next-free-cidr:
+    get:
+      description: 返回的只是建议值，创建子网时仍会重新校验。用于避免手工计算下一个空闲网段时出错。
+      operationId: suggest-subnet-cidr
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: privateNetworkId
+          required: true
+          schema:
+            format: uuid
+            type: string
+        - explode: false
+          in: query
+          name: prefix_length
+          schema:
+            default: 24
+            format: int64
+            maximum: 30
+            minimum: 16
+            type: integer
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/NextFreeCidrOutputBody"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 推荐下一个空闲网段
+      tags:
+        - Subnet
+  /api/v1/private-networks/{privateNetworkId}/subnets/{subnetId}:
+    delete:
+      description: 该子网中仍有网卡，或仍有静态路由的下一跳落在该网段内时，删除会被拒绝。
+      operationId: delete-subnet
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: privateNetworkId
+          required: true
+          schema:
+            format: uuid
+            type: string
+        - in: path
+          name: subnetId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      responses:
+        "204":
+          description: No Content
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 删除子网
+      tags:
+        - Subnet
+  /api/v1/regions:
+    get:
+      operationId: list-regions
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/RegionsOutputBody"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 列出可用的地区
+      tags:
+        - Catalog
+  /api/v1/regions/{regionCode}/availability-zones:
+    get:
+      description: 云硬盘与云服务器必须位于同一可用区才能挂载，创建前请确认所选可用区。
+      operationId: list-availability-zones
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: regionCode
+          required: true
+          schema:
+            maxLength: 32
+            type: string
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ZonesOutputBody"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 列出一个地区的可用区
+      tags:
+        - Catalog
+  /api/v1/security-groups:
+    get:
+      operationId: list-security-groups
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - explode: false
+          in: query
+          name: region_code
+          schema:
+            maxLength: 32
+            type: string
+        - description: 只返回该私有网络下的安全组
+          explode: false
+          in: query
+          name: private_network_id
+          schema:
+            description: 只返回该私有网络下的安全组
+            type: string
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/SecurityGroupsOutputBody"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 列出安全组
+      tags:
+        - SecurityGroup
+    post:
+      description: 新建的安全组带有一条规则：放行 ICMP 需要分片（type 3 code 4）。缺少该规则会导致路径 MTU 发现失败，表现为连接建立后传输大数据包时卡住。
+      operationId: create-security-group
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/CreateSecurityGroupInputBody"
+        required: true
+      responses:
+        "201":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/SecurityGroupView"
+          description: Created
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 创建安全组
+      tags:
+        - SecurityGroup
+  /api/v1/security-groups/{securityGroupId}:
+    delete:
+      description: 默认安全组不可删除，它随私有网络一并释放。仍被网卡引用的安全组也无法删除。
+      operationId: delete-security-group
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: securityGroupId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      responses:
+        "204":
+          description: No Content
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 删除安全组
+      tags:
+        - SecurityGroup
+    get:
+      operationId: get-security-group
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: securityGroupId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/SecurityGroupView"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 查看安全组
+      tags:
+        - SecurityGroup
+  /api/v1/security-groups/{securityGroupId}/rules:
+    get:
+      operationId: list-security-group-rules
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: securityGroupId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/SecurityRulesOutputBody"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 列出安全组规则
+      tags:
+        - SecurityGroup
+    post:
+      description: 重复添加同一条规则会被拒绝。判重时 `0.0.0.0/0`、`::/0` 与留空视为等同。
+      operationId: create-security-group-rule
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: securityGroupId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/CreateSecurityRuleInputBody"
+        required: true
+      responses:
+        "201":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/SecurityRuleView"
+          description: Created
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 创建安全组规则
+      tags:
+        - SecurityGroup
+  /api/v1/security-groups/{securityGroupId}/rules/{ruleId}:
+    delete:
+      operationId: delete-security-group-rule
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: securityGroupId
+          required: true
+          schema:
+            format: uuid
+            type: string
+        - in: path
+          name: ruleId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      responses:
+        "204":
+          description: No Content
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 删除安全组规则
+      tags:
+        - SecurityGroup
+  /api/v1/snapshots:
+    get:
+      operationId: list-snapshots
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/SnapshotsOutputBody"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 列出快照
+      tags:
+        - Snapshot
+    post:
+      description: 运行中云服务器上挂载的云硬盘同样可以创建快照。快照记录的是某一时刻的块设备状态，文件系统层面可能不一致，重要数据建议先在云服务器内执行 sync。
+      operationId: create-snapshot
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/CreateSnapshotInputBody"
+        required: true
+      responses:
+        "201":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/SnapshotView"
+          description: Created
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 创建快照
+      tags:
+        - Snapshot
+  /api/v1/snapshots/{snapshotId}:
+    delete:
+      operationId: delete-snapshot
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: snapshotId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      responses:
+        "204":
+          description: No Content
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 删除快照
+      tags:
+        - Snapshot
+    get:
+      operationId: get-snapshot
+      parameters:
+        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+          in: header
+          name: Authorization
+          required: true
+          schema:
+            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径和请求头上都没有 project_id
+            type: string
+        - in: path
+          name: snapshotId
+          required: true
+          schema:
+            format: uuid
+            type: string
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/SnapshotView"
+          description: OK
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+          description: Error
+      summary: 查看快照
+      tags:
+        - Snapshot
+