cloudpods/docs/schemas/common.yaml

ResourceBaseResponse:
  type: object
  properties:
    created_at:
      type: string
      example: "2019-06-10T03:39:02.000000Z"
      description: 创建时间
      readOnly: true
    updated_at:
      type: string
      example: "2019-06-11T03:39:02.000000Z"
      description: 更新时间
      readOnly: true
    deleted_at:
      type: string
      example: "2019-06-12T03:39:02.000000Z"
      description: 删除时间
      readOnly: true
    deleted:
      type: boolean
      example: true
      description: 已删除
      readOnly: true

ManagedResourceBaseResponse:
  type: object
  properties:
    managed_id:
      type: string
      example: 3209e9b5-c32a-4e4d-84e5-650d7ecb9d8e
      description: 子订阅ID
      readOnly: true

CloudregionResourceBaseResponse:
  type: object
  properties:
    cloudregion_id:
      type: string
      example: 5fbbdfaa-46ba-433a-81be-b3581ac55bfa
      description: 区域ID
    cloudregion:
      type: string
      example: 阿里云 马来西亚（吉隆坡）
      description: 区域名称


ZoneResourceBaseResponse:
  type: object
  properties:
    zone_id:
      type: string
      example: d0e8d9c2-a21d-447e-8984-50838f4cd3fa
      description: 可用区区域ID
    zone:
      type: string
      example: 阿里云 中东东部1 可用区A
      description: 可用区域名称


BillingResourceBaseResponse:
  type: object
  properties:
    billing_type:
      type: string
      example: prepaid
      default: postpaid
      description: 计费类型, 预付费、后付费
    expired_at:
      type: string
      example: "2019-12-17T16:00:00.000000Z"
      description: 到期时间
      readOnly: true

ProjectizedResourceBaseResponse:
  type: object
  properties:
    project_id:
      type: string
      example: cb58813d83284a7f95040901639013d3
      description: 资源所属项目ID
      readOnly: true  
    domain_id:
      type: string
      example: 9c06c2082007459f81b6e355eedf22fd
      description: 资源所属域ID
      readOnly: true   

ExternalizedResourceBaseResponse:
  type: object
  properties:
    external_id:
      type: string
      example: "i-7948b8d96f"
      description: 资源External ID
      readOnly: true  

StandaloneResponse:
  allOf:
    - $ref: '#/ResourceBaseResponse'
    - type: object
      properties:
        id:
          type: string
          example: fc06c2082007459f81b6e355eedf22fd
          description: 资源ID
          readOnly: true
        name:
          type: string
          example: webserver
          description: 资源名称
          readOnly: true
        description:
          type: string
          example: onecloud webserver
          description: 资源描述
          readOnly: true                   

StatusStandaloneResponse:
  allOf:
    - $ref: '#/StandaloneResponse'
    - type: object
      properties:
        status:
          type: string
          example: running
          description: 资源状态
          readOnly: true          

EnabledStatusStandaloneResponse:
  allOf:
    - $ref: './common.yaml#/StatusStandaloneResponse'
    - type: object
      properties:
        enabled:
          type: boolean
          example: true
          desciption: 资源是否启用
          readOnly: false

VirtualResourceBaseResponse:
  allOf:
    - $ref: '#/StatusStandaloneResponse'
    - $ref: '#/ProjectizedResourceBaseResponse'
    - type: object
      properties:
        project_src:
          type: string
          example: local
          description: 资源Src
          readOnly: true 
        is_system:
          type: boolean
          description: 系统资源
          readOnly: true   

SharableVirtualResourceBaseResponse:
  allOf:
    - $ref: '#/VirtualResourceBaseResponse'
    - $ref: '#/ProjectizedResourceBaseResponse'
    - type: object
      properties:
        is_public:
          type: boolean
          description: Is Public?
          readOnly: true 
        public_scope:
          type: string
          example: system
          description: public_scope
          readOnly: true           
          
BillingBaseResponse:
  type: object
  properties:
    billing_type:
      type: string
      example: postpaid
      enum: [postpaid, prepaid]
      description: 资源计费类型
    expired_at:
      type: string
      example: "2019-06-11T03:39:02.000000Z"
      description: 资源到期时间,仅对预付费类型资源有效

ProviderBaseResponse:
  type: object
  properties:
    region_id:
      type: string
      example: 5fbbdfaa-46ba-433a-81be-b3581ac55bfa
      description: 区域ID
    region_external_id:
      type: string
      example: 5fbbdfaa-46ba-433a-81be-b3581ac55bfa
      description: 区域云端ID
    region:
      type: string
      example: 阿里云 马来西亚（吉隆坡）
      description: 区域名称
    project_domain:
      type: string
      example: Default
      description: 项目
    manager:
      type: string
      example: Default
      description: 云账号
    manager_id:
      type: string
      example: 7b972be9-fd8a-43f5-8058-3820553f61c4
      description: 云账号ID