GET /api/subnets
子網路清單

GET /api/domains/:domain_id/subnets
區域的子網路清單

GET /api/locations/:location_id/subnets
各個位置上的子網路之清單

GET /api/organizations/:organization_id/subnets
各個組織中的子網路之清單

參數

參數名字 描述
domain_id
選填

區域的 ID

Validations:

  • Must be a String

location_id
選填

位置範圍

Validations:

  • Must be a Integer

organization_id
選填

組織範圍

Validations:

  • Must be a Integer

search
選填

篩選結果

Validations:

  • Must be a String

order
選填

排序結果

Validations:

  • Must be a String

page
選填

編頁結果

Validations:

  • Must be a String

per_page
選填

每個請求的項目數量

Validations:

  • Must be a String


GET /api/subnets/:id
顯示子網路

參數

參數名字 描述
id
必填

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

show_hidden_parameters
選填

Display hidden parameter values

Validations:

  • Must be one of: true, false, 1, 0


POST /api/subnets
建立子網路

參數

參數名字 描述
subnet
必填

Validations:

  • Must be a Hash

subnet[name]
必填

子網路名稱

Validations:

  • Must be a String

subnet[description]
選填 , 允許空值

Subnet description

Validations:

  • Must be a String

subnet[network_type]
選填 , 允許空值

Type or protocol, IPv4 or IPv6, defaults to IPv4

Validations:

  • Must be one of: IPv4, IPv6.

subnet[network]
必填

子網路

Validations:

  • Must be a String

subnet[mask]
必填

這個子網路的網路遮罩

Validations:

  • Must be a String

subnet[gateway]
選填 , 允許空值

這個子網路的主要 DNS

Validations:

  • Must be a String

subnet[dns_primary]
選填 , 允許空值

這個子網路的主要 DNS

Validations:

  • Must be a String

subnet[dns_secondary]
選填 , 允許空值

這個子網路的次要 DNS

Validations:

  • Must be a String

subnet[ipam]
選填 , 允許空值

這個子網路的 IP 位址自動建議模式,有效的值為「DHCP」、「Internal DB」、「None」

Validations:

  • Must be a String

subnet[from]
選填 , 允許空值

IP 自動建議的起始 IP 位址

Validations:

  • Must be a String

subnet[to]
選填 , 允許空值

IP 自動建議的結尾 IP 位址

Validations:

  • Must be a String

subnet[vlanid]
選填 , 允許空值

這個子網路的 VLAN ID

Validations:

  • Must be a String

subnet[domain_ids]
選填 , 允許空值

這個子網路所屬於的網域

Validations:

  • Must be an array of any type

subnet[dhcp_id]
選填 , 允許空值

DHCP Proxy ID to use within this subnet

Validations:

  • Must be a number.

subnet[tftp_id]
選填 , 允許空值

TFTP Proxy ID to use within this subnet

Validations:

  • Must be a number.

subnet[dns_id]
選填 , 允許空值

DNS Proxy ID to use within this subnet

Validations:

  • Must be a number.

subnet[boot_mode]
選填 , 允許空值

指定給這個子網路的介面卡的預設啟動模式,有效的值為「Static」、「DHCP」

Validations:

  • Must be a String

subnet[subnet_parameters_attributes]
選填 , 允許空值

參數陣列(名稱、值)

Validations:

  • Must be an array of any type

subnet[location_ids]
選填 , 允許空值

將位置取代為特定 ID

Validations:

  • Must be an array of any type

subnet[organization_ids]
選填 , 允許空值

將組織取代為特定 ID。

Validations:

  • Must be an array of any type


PUT /api/subnets/:id
更新子網路

參數

參數名字 描述
id
必填

子網路的數字辨識子

Validations:

  • Must be a number.

subnet
必填

Validations:

  • Must be a Hash

subnet[name]
選填

子網路名稱

Validations:

  • Must be a String

subnet[description]
選填 , 允許空值

Subnet description

Validations:

  • Must be a String

subnet[network_type]
選填 , 允許空值

Type or protocol, IPv4 or IPv6, defaults to IPv4

Validations:

  • Must be one of: IPv4, IPv6.

subnet[network]
選填

子網路

Validations:

  • Must be a String

subnet[mask]
選填

這個子網路的網路遮罩

Validations:

  • Must be a String

subnet[gateway]
選填 , 允許空值

這個子網路的主要 DNS

Validations:

  • Must be a String

subnet[dns_primary]
選填 , 允許空值

這個子網路的主要 DNS

Validations:

  • Must be a String

subnet[dns_secondary]
選填 , 允許空值

這個子網路的次要 DNS

Validations:

  • Must be a String

subnet[ipam]
選填 , 允許空值

這個子網路的 IP 位址自動建議模式,有效的值為「DHCP」、「Internal DB」、「None」

Validations:

  • Must be a String

subnet[from]
選填 , 允許空值

IP 自動建議的起始 IP 位址

Validations:

  • Must be a String

subnet[to]
選填 , 允許空值

IP 自動建議的結尾 IP 位址

Validations:

  • Must be a String

subnet[vlanid]
選填 , 允許空值

這個子網路的 VLAN ID

Validations:

  • Must be a String

subnet[domain_ids]
選填 , 允許空值

這個子網路所屬於的網域

Validations:

  • Must be an array of any type

subnet[dhcp_id]
選填 , 允許空值

DHCP Proxy ID to use within this subnet

Validations:

  • Must be a number.

subnet[tftp_id]
選填 , 允許空值

TFTP Proxy ID to use within this subnet

Validations:

  • Must be a number.

subnet[dns_id]
選填 , 允許空值

DNS Proxy ID to use within this subnet

Validations:

  • Must be a number.

subnet[boot_mode]
選填 , 允許空值

指定給這個子網路的介面卡的預設啟動模式,有效的值為「Static」、「DHCP」

Validations:

  • Must be a String

subnet[subnet_parameters_attributes]
選填 , 允許空值

參數陣列(名稱、值)

Validations:

  • Must be an array of any type

subnet[location_ids]
選填 , 允許空值

將位置取代為特定 ID

Validations:

  • Must be an array of any type

subnet[organization_ids]
選填 , 允許空值

將組織取代為特定 ID。

Validations:

  • Must be an array of any type


DELETE /api/subnets/:id
刪除子網路

參數

參數名字 描述
id
必填

子網路的數字辨識子

Validations:

  • Must be a number.


GET /api/subnets/:id/freeip
Provides an unused IP address in this subnet

參數

參數名字 描述
id
必填

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

mac
選填

MAC address to reuse the IP for this host

Validations:

  • Must be a String

excluded_ips
選填

IP addresses that should be excluded from suggestion

Validations:

  • Must be an array of any type