Files
cloudpods/docs/schemas/elasticip.yaml
T
2019-07-24 16:10:06 +08:00

127 lines
3.3 KiB
YAML

ElasticIpCreate:
type: object
properties:
name:
type: string
example: test-elasticip
required: true
description: 弹性IP名称
description:
type: string
example: elasticip-description
description: 弹性IP描述
region:
type: string
example: be2581d5-4c35-4e5d-8235-8861061b660d
required: true
description: 区域名称或ID
manager:
type: string
example: b3b6fcc4-3fa5-450a-89b5-26d855e6f102
required: true
description: 子订阅名称或ID
charge_type:
type: string
example: bandwidth
default: triffic
description: 计费类型,traffic or bandwidth
network:
type: string
example: be2581d5-4c35-4e5d-8235-8861061b660d
description: 子网名称或ID,私有云必须指定子网
bandwidth:
type: integer
default: 0
description: 带宽大小
auto_dellocate:
type: boolean
default: false
description: 是否解绑时自动删除
ip_addr:
type: string
description: 仅私有云可以指定ip子网内的IP
ElasticIpResponse:
type: object
properties:
elasticip:
type: object
$ref: '#/ElasticIp'
ElasticIp:
allOf:
- $ref: "./common.yaml#/VirtualResourceBaseResponse"
- $ref: "./common.yaml#/BillingBaseResponse"
- $ref: "./common.yaml#/ExternalizedResourceBaseResponse"
- type: object
properties:
associate_id:
type: string
example: 0b50463b-929f-44a1-86e0-274f73f9de05
description: 弹性IP绑定的设备ID
associate_type:
type: string
example: server
enum: [loadbalancer, server, natgateway]
description: 弹性IP绑定的设备类型
bandwidth:
type: integer
example: 0
description: 弹性IP带宽大小,单位(Mbps)
network_id:
type: string
example: be2581d5-4c35-4e5d-8235-8861061b660d
description: IP子网ID,目前仅私有云会有这个字段
mode:
type: string
example: elastic_ip
enum: [elastic_ip, public_ip]
description: 弹性IP或固定公网IP
ip_addr:
type: stirng
example: 47.93.237.215
description: 弹性IP地址
charge_type:
type: string
example: traffic
enum: [traffic, bandwidth]
description: 按带宽还是按流量计费
# bgp_type:
# type: string
# example:
# description: 目前华为云需要此字段
auto_dellocate:
type: boolean
example: false
description: 解绑EIP时是否自动删除EIP
cloudregion_id:
type: string
example: 60c86e4a-5a44-48c3-8ddb-57799a2207e2
description: 所在区域ID
ElasticIpListResponse:
type: object
properties:
limit:
type: integer
example: 20
elasticips:
type: array
items:
$ref: '#/ElasticIp'
total:
type: integer
example: 124
ElasticIpUpdate:
type: object
properties:
name:
type: string
example: test-keypair
description: 弹性IP名称
description:
type: string
example: keypair-description
description: 弹性IP描述