Back to Details

telnyx-networking-ruby

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese
<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. -->
<!-- 从Telnyx OpenAPI规范自动生成，请勿编辑。 -->

Telnyx Networking - Ruby

Telnyx 网络服务 - Ruby

Installation

安装

bash
gem install telnyx
bash
gem install telnyx

Setup

初始化设置

ruby
require "telnyx"

client = Telnyx::Client.new(
  api_key: ENV["TELNYX_API_KEY"], # This is the default and can be omitted
)
All examples below assume 
client
is already initialized as shown above.
ruby
require "telnyx"

client = Telnyx::Client.new(
  api_key: ENV["TELNYX_API_KEY"], # 这是默认配置，可以省略
)
以下所有示例均假设
client
已按照上述方式完成初始化。

Error Handling

错误处理

All API calls can fail with network errors, rate limits (429), validation errors (422), or authentication errors (401). Always handle errors in production code:
ruby
begin
  result = client.messages.send_(to: "+13125550001", from: "+13125550002", text: "Hello")
rescue Telnyx::Errors::APIConnectionError
  puts "Network error — check connectivity and retry"
rescue Telnyx::Errors::RateLimitError
  # 429: rate limited — wait and retry with exponential backoff
  sleep(1) # Check Retry-After header for actual delay
rescue Telnyx::Errors::APIStatusError => e
  puts "API error #{e.status}: #{e.message}"
  if e.status == 422
    puts "Validation error — check required fields and formats"
  end
end
Common error codes: 
401
invalid API key, 
403
insufficient permissions, 
404
resource not found, 
422
validation error (check field formats), 
429
rate limited (retry with exponential backoff).
所有API调用都可能出现失败情况，原因包括网络错误、速率限制(429)、校验错误(422)或认证错误(401)。在生产代码中请务必处理这些错误：
ruby
begin
  result = client.messages.send_(to: "+13125550001", from: "+13125550002", text: "Hello")
rescue Telnyx::Errors::APIConnectionError
  puts "Network error — check connectivity and retry"
rescue Telnyx::Errors::RateLimitError
  # 429: 触发速率限制 — 等待后使用指数退避策略重试
  sleep(1) # 可查看Retry-After响应头获取准确的等待时长
rescue Telnyx::Errors::APIStatusError => e
  puts "API error #{e.status}: #{e.message}"
  if e.status == 422
    puts "校验错误 — 检查必填字段和格式是否正确"
  end
end
常见错误码：
401
API密钥无效、
403
权限不足、
404
资源不存在、
422
校验错误（检查字段格式）、
429
触发速率限制（使用指数退避策略重试）。

Important Notes

重要注意事项

  • Pagination: Use 
    .auto_paging_each
    for automatic iteration: 
    page.auto_paging_each { |item| puts item.id }
    .
  • 分页： 使用
    .auto_paging_each
    实现自动遍历：
    page.auto_paging_each { |item| puts item.id }
    。

List all clusters

列出所有集群

GET /ai/clusters
ruby
page = client.ai.clusters.list

puts(page)
Returns: 
bucket
(string), 
created_at
(date-time), 
finished_at
(date-time), 
min_cluster_size
(integer), 
min_subcluster_size
(integer), 
status
(enum: pending, starting, running, completed, failed), 
task_id
(string)
GET /ai/clusters
ruby
page = client.ai.clusters.list

puts(page)
返回参数：
bucket
(字符串)、
created_at
(日期时间)、
finished_at
(日期时间)、
min_cluster_size
(整数)、
min_subcluster_size
(整数)、
status
(枚举值：pending, starting, running, completed, failed)、
task_id
(字符串)

Compute new clusters

计算新集群

Starts a background task to compute how the data in an embedded storage bucket is clustered. This helps identify common themes and patterns in the data.
POST /ai/clusters
— Required: 
bucket
Optional: 
files
(array[string]), 
min_cluster_size
(integer), 
min_subcluster_size
(integer), 
prefix
(string)
ruby
response = client.ai.clusters.compute(bucket: "my-bucket")

puts(response)
Returns: 
task_id
(string)
启动后台任务，计算嵌入式存储桶中的数据聚类方式，可帮助识别数据中的通用主题和模式。
POST /ai/clusters
— 必填参数：
bucket
可选参数：
files
(字符串数组)、
min_cluster_size
(整数)、
min_subcluster_size
(整数)、
prefix
(字符串)
ruby
response = client.ai.clusters.compute(bucket: "my-bucket")

puts(response)
返回参数：
task_id
(字符串)

Fetch a cluster

获取单个集群详情

GET /ai/clusters/{task_id}
ruby
cluster = client.ai.clusters.retrieve("task_id")

puts(cluster)
Returns: 
bucket
(string), 
clusters
(array[object]), 
status
(enum: pending, starting, running, completed, failed)
GET /ai/clusters/{task_id}
ruby
cluster = client.ai.clusters.retrieve("task_id")

puts(cluster)
返回参数：
bucket
(字符串)、
clusters
(对象数组)、
status
(枚举值：pending, starting, running, completed, failed)

Delete a cluster

删除集群

DELETE /ai/clusters/{task_id}
ruby
result = client.ai.clusters.delete("task_id")

puts(result)
DELETE /ai/clusters/{task_id}
ruby
result = client.ai.clusters.delete("task_id")

puts(result)

Fetch a cluster visualization

获取集群可视化数据

GET /ai/clusters/{task_id}/graph
ruby
response = client.ai.clusters.fetch_graph("task_id")

puts(response)
GET /ai/clusters/{task_id}/graph
ruby
response = client.ai.clusters.fetch_graph("task_id")

puts(response)

List Integrations

列出所有集成

List all available integrations.
GET /ai/integrations
ruby
integrations = client.ai.integrations.list

puts(integrations)
Returns: 
available_tools
(array[string]), 
description
(string), 
display_name
(string), 
id
(string), 
logo_url
(string), 
name
(string), 
status
(enum: disconnected, connected)
列出所有可用的集成项。
GET /ai/integrations
ruby
integrations = client.ai.integrations.list

puts(integrations)
返回参数：
available_tools
(字符串数组)、
description
(字符串)、
display_name
(字符串)、
id
(字符串)、
logo_url
(字符串)、
name
(字符串)、
status
(枚举值：disconnected, connected)

List User Integrations

列出用户已配置的集成

List user setup integrations
GET /ai/integrations/connections
ruby
connections = client.ai.integrations.connections.list

puts(connections)
Returns: 
allowed_tools
(array[string]), 
id
(string), 
integration_id
(string)
列出用户已设置的集成项
GET /ai/integrations/connections
ruby
connections = client.ai.integrations.connections.list

puts(connections)
返回参数：
allowed_tools
(字符串数组)、
id
(字符串)、
integration_id
(字符串)

Get User Integration connection By Id

根据ID获取用户集成连接详情

Get user setup integrations
GET /ai/integrations/connections/{user_connection_id}
ruby
connection = client.ai.integrations.connections.retrieve("user_connection_id")

puts(connection)
Returns: 
allowed_tools
(array[string]), 
id
(string), 
integration_id
(string)
获取用户已设置的集成项
GET /ai/integrations/connections/{user_connection_id}
ruby
connection = client.ai.integrations.connections.retrieve("user_connection_id")

puts(connection)
返回参数：
allowed_tools
(字符串数组)、
id
(字符串)、
integration_id
(字符串)

Delete Integration Connection

删除集成连接

Delete a specific integration connection.
DELETE /ai/integrations/connections/{user_connection_id}
ruby
result = client.ai.integrations.connections.delete("user_connection_id")

puts(result)
删除指定的集成连接。
DELETE /ai/integrations/connections/{user_connection_id}
ruby
result = client.ai.integrations.connections.delete("user_connection_id")

puts(result)

List Integration By Id

根据ID获取集成详情

Retrieve integration details
GET /ai/integrations/{integration_id}
ruby
integration = client.ai.integrations.retrieve("integration_id")

puts(integration)
Returns: 
available_tools
(array[string]), 
description
(string), 
display_name
(string), 
id
(string), 
logo_url
(string), 
name
(string), 
status
(enum: disconnected, connected)
获取集成的详细信息
GET /ai/integrations/{integration_id}
ruby
integration = client.ai.integrations.retrieve("integration_id")

puts(integration)
返回参数：
available_tools
(字符串数组)、
description
(字符串)、
display_name
(字符串)、
id
(字符串)、
logo_url
(字符串)、
name
(字符串)、
status
(枚举值：disconnected, connected)

List all Global IP Allowed Ports

列出所有全局IP允许端口

GET /global_ip_allowed_ports
ruby
global_ip_allowed_ports = client.global_ip_allowed_ports.list

puts(global_ip_allowed_ports)
Returns: 
first_port
(integer), 
id
(uuid), 
last_port
(integer), 
name
(string), 
protocol_code
(string), 
record_type
(string)
GET /global_ip_allowed_ports
ruby
global_ip_allowed_ports = client.global_ip_allowed_ports.list

puts(global_ip_allowed_ports)
返回参数：
first_port
(整数)、
id
(uuid)、
last_port
(整数)、
name
(字符串)、
protocol_code
(字符串)、
record_type
(字符串)

Global IP Assignment Health Check Metrics

获取全局IP分配健康检查指标

GET /global_ip_assignment_health
ruby
global_ip_assignment_health = client.global_ip_assignment_health.retrieve

puts(global_ip_assignment_health)
Returns: 
global_ip
(object), 
global_ip_assignment
(object), 
health
(object), 
timestamp
(date-time)
GET /global_ip_assignment_health
ruby
global_ip_assignment_health = client.global_ip_assignment_health.retrieve

puts(global_ip_assignment_health)
返回参数：
global_ip
(对象)、
global_ip_assignment
(对象)、
health
(对象)、
timestamp
(日期时间)

List all Global IP assignments

列出所有全局IP分配记录

List all Global IP assignments.
GET /global_ip_assignments
ruby
page = client.global_ip_assignments.list

puts(page)
Returns: 
created_at
(string), 
global_ip_id
(uuid), 
id
(uuid), 
is_announced
(boolean), 
is_connected
(boolean), 
is_in_maintenance
(boolean), 
record_type
(string), 
status
(enum: created, provisioning, provisioned, deleting), 
updated_at
(string), 
wireguard_peer_id
(uuid)
列出所有全局IP分配记录。
GET /global_ip_assignments
ruby
page = client.global_ip_assignments.list

puts(page)
返回参数：
created_at
(字符串)、
global_ip_id
(uuid)、
id
(uuid)、
is_announced
(布尔值)、
is_connected
(布尔值)、
is_in_maintenance
(布尔值)、
record_type
(字符串)、
status
(枚举值：created, provisioning, provisioned, deleting)、
updated_at
(字符串)、
wireguard_peer_id
(uuid)

Create a Global IP assignment

创建全局IP分配记录

Create a Global IP assignment.
POST /global_ip_assignments
Optional: 
created_at
(string), 
global_ip_id
(uuid), 
id
(uuid), 
is_announced
(boolean), 
is_connected
(boolean), 
is_in_maintenance
(boolean), 
record_type
(string), 
status
(enum: created, provisioning, provisioned, deleting), 
updated_at
(string), 
wireguard_peer_id
(uuid)
ruby
global_ip_assignment = client.global_ip_assignments.create

puts(global_ip_assignment)
Returns: 
created_at
(string), 
global_ip_id
(uuid), 
id
(uuid), 
is_announced
(boolean), 
is_connected
(boolean), 
is_in_maintenance
(boolean), 
record_type
(string), 
status
(enum: created, provisioning, provisioned, deleting), 
updated_at
(string), 
wireguard_peer_id
(uuid)
创建一条全局IP分配记录。
POST /global_ip_assignments
可选参数：
created_at
(字符串)、
global_ip_id
(uuid)、
id
(uuid)、
is_announced
(布尔值)、
is_connected
(布尔值)、
is_in_maintenance
(布尔值)、
record_type
(字符串)、
status
(枚举值：created, provisioning, provisioned, deleting)、
updated_at
(字符串)、
wireguard_peer_id
(uuid)
ruby
global_ip_assignment = client.global_ip_assignments.create

puts(global_ip_assignment)
返回参数：
created_at
(字符串)、
global_ip_id
(uuid)、
id
(uuid)、
is_announced
(布尔值)、
is_connected
(布尔值)、
is_in_maintenance
(布尔值)、
record_type
(字符串)、
status
(枚举值：created, provisioning, provisioned, deleting)、
updated_at
(字符串)、
wireguard_peer_id
(uuid)

Retrieve a Global IP

获取全局IP详情

Retrieve a Global IP assignment.
GET /global_ip_assignments/{id}
ruby
global_ip_assignment = client.global_ip_assignments.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(global_ip_assignment)
Returns: 
created_at
(string), 
global_ip_id
(uuid), 
id
(uuid), 
is_announced
(boolean), 
is_connected
(boolean), 
is_in_maintenance
(boolean), 
record_type
(string), 
status
(enum: created, provisioning, provisioned, deleting), 
updated_at
(string), 
wireguard_peer_id
(uuid)
获取指定全局IP分配记录的详情。
GET /global_ip_assignments/{id}
ruby
global_ip_assignment = client.global_ip_assignments.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(global_ip_assignment)
返回参数：
created_at
(字符串)、
global_ip_id
(uuid)、
id
(uuid)、
is_announced
(布尔值)、
is_connected
(布尔值)、
is_in_maintenance
(布尔值)、
record_type
(字符串)、
status
(枚举值：created, provisioning, provisioned, deleting)、
updated_at
(字符串)、
wireguard_peer_id
(uuid)

Update a Global IP assignment

更新全局IP分配记录

Update a Global IP assignment.
PATCH /global_ip_assignments/{id}
Optional: 
created_at
(string), 
global_ip_id
(string), 
id
(uuid), 
is_announced
(boolean), 
is_connected
(boolean), 
is_in_maintenance
(boolean), 
record_type
(string), 
status
(enum: created, provisioning, provisioned, deleting), 
updated_at
(string), 
wireguard_peer_id
(string)
ruby
global_ip_assignment = client.global_ip_assignments.update(
  "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  global_ip_assignment_update_request: {}
)

puts(global_ip_assignment)
Returns: 
created_at
(string), 
global_ip_id
(uuid), 
id
(uuid), 
is_announced
(boolean), 
is_connected
(boolean), 
is_in_maintenance
(boolean), 
record_type
(string), 
status
(enum: created, provisioning, provisioned, deleting), 
updated_at
(string), 
wireguard_peer_id
(uuid)
更新指定全局IP分配记录。
PATCH /global_ip_assignments/{id}
可选参数：
created_at
(字符串)、
global_ip_id
(字符串)、
id
(uuid)、
is_announced
(布尔值)、
is_connected
(布尔值)、
is_in_maintenance
(布尔值)、
record_type
(字符串)、
status
(枚举值：created, provisioning, provisioned, deleting)、
updated_at
(字符串)、
wireguard_peer_id
(字符串)
ruby
global_ip_assignment = client.global_ip_assignments.update(
  "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  global_ip_assignment_update_request: {}
)

puts(global_ip_assignment)
返回参数：
created_at
(字符串)、
global_ip_id
(uuid)、
id
(uuid)、
is_announced
(布尔值)、
is_connected
(布尔值)、
is_in_maintenance
(布尔值)、
record_type
(字符串)、
status
(枚举值：created, provisioning, provisioned, deleting)、
updated_at
(字符串)、
wireguard_peer_id
(uuid)

Delete a Global IP assignment

删除全局IP分配记录

Delete a Global IP assignment.
DELETE /global_ip_assignments/{id}
ruby
global_ip_assignment = client.global_ip_assignments.delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(global_ip_assignment)
Returns: 
created_at
(string), 
global_ip_id
(uuid), 
id
(uuid), 
is_announced
(boolean), 
is_connected
(boolean), 
is_in_maintenance
(boolean), 
record_type
(string), 
status
(enum: created, provisioning, provisioned, deleting), 
updated_at
(string), 
wireguard_peer_id
(uuid)
删除指定全局IP分配记录。
DELETE /global_ip_assignments/{id}
ruby
global_ip_assignment = client.global_ip_assignments.delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(global_ip_assignment)
返回参数：
created_at
(字符串)、
global_ip_id
(uuid)、
id
(uuid)、
is_announced
(布尔值)、
is_connected
(布尔值)、
is_in_maintenance
(布尔值)、
record_type
(字符串)、
status
(枚举值：created, provisioning, provisioned, deleting)、
updated_at
(字符串)、
wireguard_peer_id
(uuid)

Global IP Assignment Usage Metrics

获取全局IP分配使用指标

GET /global_ip_assignments_usage
ruby
global_ip_assignments_usage = client.global_ip_assignments_usage.retrieve

puts(global_ip_assignments_usage)
Returns: 
global_ip
(object), 
global_ip_assignment
(object), 
received
(object), 
timestamp
(date-time), 
transmitted
(object)
GET /global_ip_assignments_usage
ruby
global_ip_assignments_usage = client.global_ip_assignments_usage.retrieve

puts(global_ip_assignments_usage)
返回参数：
global_ip
(对象)、
global_ip_assignment
(对象)、
received
(对象)、
timestamp
(日期时间)、
transmitted
(对象)

List all Global IP Health check types

列出所有全局IP健康检查类型

List all Global IP Health check types.
GET /global_ip_health_check_types
ruby
global_ip_health_check_types = client.global_ip_health_check_types.list

puts(global_ip_health_check_types)
Returns: 
health_check_params
(object), 
health_check_type
(string), 
record_type
(string)
列出所有全局IP健康检查类型。
GET /global_ip_health_check_types
ruby
global_ip_health_check_types = client.global_ip_health_check_types.list

puts(global_ip_health_check_types)
返回参数：
health_check_params
(对象)、
health_check_type
(字符串)、
record_type
(字符串)

List all Global IP health checks

列出所有全局IP健康检查记录

List all Global IP health checks.
GET /global_ip_health_checks
ruby
page = client.global_ip_health_checks.list

puts(page)
Returns: 
created_at
(string), 
global_ip_id
(uuid), 
health_check_params
(object), 
health_check_type
(string), 
id
(uuid), 
record_type
(string), 
updated_at
(string)
列出所有全局IP健康检查记录。
GET /global_ip_health_checks
ruby
page = client.global_ip_health_checks.list

puts(page)
返回参数：
created_at
(字符串)、
global_ip_id
(uuid)、
health_check_params
(对象)、
health_check_type
(字符串)、
id
(uuid)、
record_type
(字符串)、
updated_at
(字符串)

Create a Global IP health check

创建全局IP健康检查

Create a Global IP health check.
POST /global_ip_health_checks
Optional: 
created_at
(string), 
global_ip_id
(uuid), 
health_check_params
(object), 
health_check_type
(string), 
id
(uuid), 
record_type
(string), 
updated_at
(string)
ruby
global_ip_health_check = client.global_ip_health_checks.create

puts(global_ip_health_check)
Returns: 
created_at
(string), 
global_ip_id
(uuid), 
health_check_params
(object), 
health_check_type
(string), 
id
(uuid), 
record_type
(string), 
updated_at
(string)
创建一条全局IP健康检查记录。
POST /global_ip_health_checks
可选参数：
created_at
(字符串)、
global_ip_id
(uuid)、
health_check_params
(对象)、
health_check_type
(字符串)、
id
(uuid)、
record_type
(字符串)、
updated_at
(字符串)
ruby
global_ip_health_check = client.global_ip_health_checks.create

puts(global_ip_health_check)
返回参数：
created_at
(字符串)、
global_ip_id
(uuid)、
health_check_params
(对象)、
health_check_type
(字符串)、
id
(uuid)、
record_type
(字符串)、
updated_at
(字符串)

Retrieve a Global IP health check

获取全局IP健康检查详情

Retrieve a Global IP health check.
GET /global_ip_health_checks/{id}
ruby
global_ip_health_check = client.global_ip_health_checks.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(global_ip_health_check)
Returns: 
created_at
(string), 
global_ip_id
(uuid), 
health_check_params
(object), 
health_check_type
(string), 
id
(uuid), 
record_type
(string), 
updated_at
(string)
获取指定全局IP健康检查记录的详情。
GET /global_ip_health_checks/{id}
ruby
global_ip_health_check = client.global_ip_health_checks.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(global_ip_health_check)
返回参数：
created_at
(字符串)、
global_ip_id
(uuid)、
health_check_params
(对象)、
health_check_type
(字符串)、
id
(uuid)、
record_type
(字符串)、
updated_at
(字符串)

Delete a Global IP health check

删除全局IP健康检查

Delete a Global IP health check.
DELETE /global_ip_health_checks/{id}
ruby
global_ip_health_check = client.global_ip_health_checks.delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(global_ip_health_check)
Returns: 
created_at
(string), 
global_ip_id
(uuid), 
health_check_params
(object), 
health_check_type
(string), 
id
(uuid), 
record_type
(string), 
updated_at
(string)
删除指定全局IP健康检查记录。
DELETE /global_ip_health_checks/{id}
ruby
global_ip_health_check = client.global_ip_health_checks.delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(global_ip_health_check)
返回参数：
created_at
(字符串)、
global_ip_id
(uuid)、
health_check_params
(对象)、
health_check_type
(字符串)、
id
(uuid)、
record_type
(字符串)、
updated_at
(字符串)

Global IP Latency Metrics

获取全局IP延迟指标

GET /global_ip_latency
ruby
global_ip_latency = client.global_ip_latency.retrieve

puts(global_ip_latency)
Returns: 
global_ip
(object), 
mean_latency
(object), 
percentile_latency
(object), 
prober_location
(object), 
timestamp
(date-time)
GET /global_ip_latency
ruby
global_ip_latency = client.global_ip_latency.retrieve

puts(global_ip_latency)
返回参数：
global_ip
(对象)、
mean_latency
(对象)、
percentile_latency
(对象)、
prober_location
(对象)、
timestamp
(日期时间)

List all Global IP Protocols

列出所有全局IP协议

GET /global_ip_protocols
ruby
global_ip_protocols = client.global_ip_protocols.list

puts(global_ip_protocols)
Returns: 
code
(string), 
name
(string), 
record_type
(string)
GET /global_ip_protocols
ruby
global_ip_protocols = client.global_ip_protocols.list

puts(global_ip_protocols)
返回参数：
code
(字符串)、
name
(字符串)、
record_type
(字符串)

Global IP Usage Metrics

获取全局IP使用指标

GET /global_ip_usage
ruby
global_ip_usage = client.global_ip_usage.retrieve

puts(global_ip_usage)
Returns: 
global_ip
(object), 
received
(object), 
timestamp
(date-time), 
transmitted
(object)
GET /global_ip_usage
ruby
global_ip_usage = client.global_ip_usage.retrieve

puts(global_ip_usage)
返回参数：
global_ip
(对象)、
received
(对象)、
timestamp
(日期时间)、
transmitted
(对象)

List all Global IPs

列出所有全局IP

List all Global IPs.
GET /global_ips
ruby
page = client.global_ips.list

puts(page)
Returns: 
created_at
(string), 
description
(string), 
id
(uuid), 
ip_address
(string), 
name
(string), 
ports
(object), 
record_type
(string), 
updated_at
(string)
列出所有全局IP。
GET /global_ips
ruby
page = client.global_ips.list

puts(page)
返回参数：
created_at
(字符串)、
description
(字符串)、
id
(uuid)、
ip_address
(字符串)、
name
(字符串)、
ports
(对象)、
record_type
(字符串)、
updated_at
(字符串)

Create a Global IP

创建全局IP

Create a Global IP.
POST /global_ips
Optional: 
created_at
(string), 
description
(string), 
id
(uuid), 
ip_address
(string), 
name
(string), 
ports
(object), 
record_type
(string), 
updated_at
(string)
ruby
global_ip = client.global_ips.create

puts(global_ip)
Returns: 
created_at
(string), 
description
(string), 
id
(uuid), 
ip_address
(string), 
name
(string), 
ports
(object), 
record_type
(string), 
updated_at
(string)
创建一个全局IP。
POST /global_ips
可选参数：
created_at
(字符串)、
description
(字符串)、
id
(uuid)、
ip_address
(字符串)、
name
(字符串)、
ports
(对象)、
record_type
(字符串)、
updated_at
(字符串)
ruby
global_ip = client.global_ips.create

puts(global_ip)
返回参数：
created_at
(字符串)、
description
(字符串)、
id
(uuid)、
ip_address
(字符串)、
name
(字符串)、
ports
(对象)、
record_type
(字符串)、
updated_at
(字符串)

Retrieve a Global IP

获取全局IP详情

Retrieve a Global IP.
GET /global_ips/{id}
ruby
global_ip = client.global_ips.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(global_ip)
Returns: 
created_at
(string), 
description
(string), 
id
(uuid), 
ip_address
(string), 
name
(string), 
ports
(object), 
record_type
(string), 
updated_at
(string)
获取指定全局IP的详情。
GET /global_ips/{id}
ruby
global_ip = client.global_ips.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(global_ip)
返回参数：
created_at
(字符串)、
description
(字符串)、
id
(uuid)、
ip_address
(字符串)、
name
(字符串)、
ports
(对象)、
record_type
(字符串)、
updated_at
(字符串)

Delete a Global IP

删除全局IP

Delete a Global IP.
DELETE /global_ips/{id}
ruby
global_ip = client.global_ips.delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(global_ip)
Returns: 
created_at
(string), 
description
(string), 
id
(uuid), 
ip_address
(string), 
name
(string), 
ports
(object), 
record_type
(string), 
updated_at
(string)
删除指定全局IP。
DELETE /global_ips/{id}
ruby
global_ip = client.global_ips.delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(global_ip)
返回参数：
created_at
(字符串)、
description
(字符串)、
id
(uuid)、
ip_address
(字符串)、
name
(字符串)、
ports
(对象)、
record_type
(字符串)、
updated_at
(字符串)

List all Networks

列出所有网络

List all Networks.
GET /networks
ruby
page = client.networks.list

puts(page)
Returns: 
created_at
(string), 
id
(uuid), 
name
(string), 
record_type
(string), 
updated_at
(string)
列出所有网络。
GET /networks
ruby
page = client.networks.list

puts(page)
返回参数：
created_at
(字符串)、
id
(uuid)、
name
(字符串)、
record_type
(字符串)、
updated_at
(字符串)

Create a Network

创建网络

Create a new Network.
POST /networks
— Required: 
name
Optional: 
created_at
(string), 
id
(uuid), 
record_type
(string), 
updated_at
(string)
ruby
network = client.networks.create(name: "test network")

puts(network)
Returns: 
created_at
(string), 
id
(uuid), 
name
(string), 
record_type
(string), 
updated_at
(string)
创建一个新网络。
POST /networks
— 必填参数：
name
可选参数：
created_at
(字符串)、
id
(uuid)、
record_type
(字符串)、
updated_at
(字符串)
ruby
network = client.networks.create(name: "test network")

puts(network)
返回参数：
created_at
(字符串)、
id
(uuid)、
name
(字符串)、
record_type
(字符串)、
updated_at
(字符串)

Retrieve a Network

获取网络详情

Retrieve a Network.
GET /networks/{id}
ruby
network = client.networks.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(network)
Returns: 
created_at
(string), 
id
(uuid), 
name
(string), 
record_type
(string), 
updated_at
(string)
获取指定网络的详情。
GET /networks/{id}
ruby
network = client.networks.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(network)
返回参数：
created_at
(字符串)、
id
(uuid)、
name
(字符串)、
record_type
(字符串)、
updated_at
(字符串)

Update a Network

更新网络

Update a Network.
PATCH /networks/{id}
— Required: 
name
Optional: 
created_at
(string), 
id
(uuid), 
record_type
(string), 
updated_at
(string)
ruby
network = client.networks.update("6a09cdc3-8948-47f0-aa62-74ac943d6c58", name: "test network")

puts(network)
Returns: 
created_at
(string), 
id
(uuid), 
name
(string), 
record_type
(string), 
updated_at
(string)
更新指定网络的信息。
PATCH /networks/{id}
— 必填参数：
name
可选参数：
created_at
(字符串)、
id
(uuid)、
record_type
(字符串)、
updated_at
(字符串)
ruby
network = client.networks.update("6a09cdc3-8948-47f0-aa62-74ac943d6c58", name: "test network")

puts(network)
返回参数：
created_at
(字符串)、
id
(uuid)、
name
(字符串)、
record_type
(字符串)、
updated_at
(字符串)

Delete a Network

删除网络

Delete a Network.
DELETE /networks/{id}
ruby
network = client.networks.delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(network)
Returns: 
created_at
(string), 
id
(uuid), 
name
(string), 
record_type
(string), 
updated_at
(string)
删除指定网络。
DELETE /networks/{id}
ruby
network = client.networks.delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(network)
返回参数：
created_at
(字符串)、
id
(uuid)、
name
(字符串)、
record_type
(字符串)、
updated_at
(字符串)

Get Default Gateway status.

获取默认网关状态

GET /networks/{id}/default_gateway
ruby
default_gateway = client.networks.default_gateway.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(default_gateway)
Returns: 
created_at
(string), 
id
(uuid), 
network_id
(uuid), 
record_type
(string), 
status
(enum: created, provisioning, provisioned, deleting), 
updated_at
(string), 
wireguard_peer_id
(uuid)
GET /networks/{id}/default_gateway
ruby
default_gateway = client.networks.default_gateway.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(default_gateway)
返回参数：
created_at
(字符串)、
id
(uuid)、
network_id
(uuid)、
record_type
(字符串)、
status
(枚举值：created, provisioning, provisioned, deleting)、
updated_at
(字符串)、
wireguard_peer_id
(uuid)

Create Default Gateway.

创建默认网关

POST /networks/{id}/default_gateway
Optional: 
created_at
(string), 
id
(uuid), 
network_id
(uuid), 
record_type
(string), 
status
(enum: created, provisioning, provisioned, deleting), 
updated_at
(string), 
wireguard_peer_id
(uuid)
ruby
default_gateway = client.networks.default_gateway.create("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(default_gateway)
Returns: 
created_at
(string), 
id
(uuid), 
network_id
(uuid), 
record_type
(string), 
status
(enum: created, provisioning, provisioned, deleting), 
updated_at
(string), 
wireguard_peer_id
(uuid)
POST /networks/{id}/default_gateway
可选参数：
created_at
(字符串)、
id
(uuid)、
network_id
(uuid)、
record_type
(字符串)、
status
(枚举值：created, provisioning, provisioned, deleting)、
updated_at
(字符串)、
wireguard_peer_id
(uuid)
ruby
default_gateway = client.networks.default_gateway.create("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(default_gateway)
返回参数：
created_at
(字符串)、
id
(uuid)、
network_id
(uuid)、
record_type
(字符串)、
status
(枚举值：created, provisioning, provisioned, deleting)、
updated_at
(字符串)、
wireguard_peer_id
(uuid)

Delete Default Gateway.

删除默认网关

DELETE /networks/{id}/default_gateway
ruby
default_gateway = client.networks.default_gateway.delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(default_gateway)
Returns: 
created_at
(string), 
id
(uuid), 
network_id
(uuid), 
record_type
(string), 
status
(enum: created, provisioning, provisioned, deleting), 
updated_at
(string), 
wireguard_peer_id
(uuid)
DELETE /networks/{id}/default_gateway
ruby
default_gateway = client.networks.default_gateway.delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(default_gateway)
返回参数：
created_at
(字符串)、
id
(uuid)、
network_id
(uuid)、
record_type
(字符串)、
status
(枚举值：created, provisioning, provisioned, deleting)、
updated_at
(字符串)、
wireguard_peer_id
(uuid)

List all Interfaces for a Network.

列出网络下的所有接口

GET /networks/{id}/network_interfaces
ruby
page = client.networks.list_interfaces("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(page)
Returns: 
created_at
(string), 
id
(uuid), 
name
(string), 
network_id
(uuid), 
record_type
(string), 
region
(object), 
region_code
(string), 
status
(enum: created, provisioning, provisioned, deleting), 
type
(string), 
updated_at
(string)
GET /networks/{id}/network_interfaces
ruby
page = client.networks.list_interfaces("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(page)
返回参数：
created_at
(字符串)、
id
(uuid)、
name
(字符串)、
network_id
(uuid)、
record_type
(字符串)、
region
(对象)、
region_code
(字符串)、
status
(枚举值：created, provisioning, provisioned, deleting)、
type
(字符串)、
updated_at
(字符串)

Get all Private Wireless Gateways

获取所有私有无线网关

Get all Private Wireless Gateways belonging to the user.
GET /private_wireless_gateways
ruby
page = client.private_wireless_gateways.list

puts(page)
Returns: 
assigned_resources
(array[object]), 
created_at
(string), 
id
(uuid), 
ip_range
(string), 
name
(string), 
network_id
(uuid), 
record_type
(string), 
region_code
(string), 
status
(object), 
updated_at
(string)
获取用户名下的所有私有无线网关。
GET /private_wireless_gateways
ruby
page = client.private_wireless_gateways.list

puts(page)
返回参数：
assigned_resources
(对象数组)、
created_at
(字符串)、
id
(uuid)、
ip_range
(字符串)、
name
(字符串)、
network_id
(uuid)、
record_type
(字符串)、
region_code
(字符串)、
status
(对象)、
updated_at
(字符串)

Create a Private Wireless Gateway

创建私有无线网关

Asynchronously create a Private Wireless Gateway for SIM cards for a previously created network. This operation may take several minutes so you can check the Private Wireless Gateway status at the section Get a Private Wireless Gateway.
POST /private_wireless_gateways
— Required: 
network_id
, 
name
Optional: 
region_code
(string)
ruby
private_wireless_gateway = client.private_wireless_gateways.create(
  name: "My private wireless gateway",
  network_id: "6a09cdc3-8948-47f0-aa62-74ac943d6c58"
)

puts(private_wireless_gateway)
Returns: 
assigned_resources
(array[object]), 
created_at
(string), 
id
(uuid), 
ip_range
(string), 
name
(string), 
network_id
(uuid), 
record_type
(string), 
region_code
(string), 
status
(object), 
updated_at
(string)
为已创建网络的SIM卡异步创建私有无线网关。该操作可能需要几分钟时间，你可以在「获取私有无线网关」章节查看网关的创建状态。
POST /private_wireless_gateways
— 必填参数：
network_id
、
name
可选参数：
region_code
(字符串)
ruby
private_wireless_gateway = client.private_wireless_gateways.create(
  name: "My private wireless gateway",
  network_id: "6a09cdc3-8948-47f0-aa62-74ac943d6c58"
)

puts(private_wireless_gateway)
返回参数：
assigned_resources
(对象数组)、
created_at
(字符串)、
id
(uuid)、
ip_range
(字符串)、
name
(字符串)、
network_id
(uuid)、
record_type
(字符串)、
region_code
(字符串)、
status
(对象)、
updated_at
(字符串)

Get a Private Wireless Gateway

获取私有无线网关详情

Retrieve information about a Private Wireless Gateway.
GET /private_wireless_gateways/{id}
ruby
private_wireless_gateway = client.private_wireless_gateways.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(private_wireless_gateway)
Returns: 
assigned_resources
(array[object]), 
created_at
(string), 
id
(uuid), 
ip_range
(string), 
name
(string), 
network_id
(uuid), 
record_type
(string), 
region_code
(string), 
status
(object), 
updated_at
(string)
获取指定私有无线网关的信息。
GET /private_wireless_gateways/{id}
ruby
private_wireless_gateway = client.private_wireless_gateways.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(private_wireless_gateway)
返回参数：
assigned_resources
(对象数组)、
created_at
(字符串)、
id
(uuid)、
ip_range
(字符串)、
name
(字符串)、
network_id
(uuid)、
record_type
(字符串)、
region_code
(字符串)、
status
(对象)、
updated_at
(字符串)

Delete a Private Wireless Gateway

删除私有无线网关

Deletes the Private Wireless Gateway.
DELETE /private_wireless_gateways/{id}
ruby
private_wireless_gateway = client.private_wireless_gateways.delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(private_wireless_gateway)
Returns: 
assigned_resources
(array[object]), 
created_at
(string), 
id
(uuid), 
ip_range
(string), 
name
(string), 
network_id
(uuid), 
record_type
(string), 
region_code
(string), 
status
(object), 
updated_at
(string)
删除指定私有无线网关。
DELETE /private_wireless_gateways/{id}
ruby
private_wireless_gateway = client.private_wireless_gateways.delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(private_wireless_gateway)
返回参数：
assigned_resources
(对象数组)、
created_at
(字符串)、
id
(uuid)、
ip_range
(字符串)、
name
(字符串)、
network_id
(uuid)、
record_type
(字符串)、
region_code
(字符串)、
status
(对象)、
updated_at
(字符串)

List all Public Internet Gateways

列出所有公共互联网网关

List all Public Internet Gateways.
GET /public_internet_gateways
ruby
page = client.public_internet_gateways.list

puts(page)
Returns: 
created_at
(string), 
id
(uuid), 
name
(string), 
network_id
(uuid), 
public_ip
(string), 
record_type
(string), 
region_code
(string), 
status
(enum: created, provisioning, provisioned, deleting), 
updated_at
(string)
列出所有公共互联网网关。
GET /public_internet_gateways
ruby
page = client.public_internet_gateways.list

puts(page)
返回参数：
created_at
(字符串)、
id
(uuid)、
name
(字符串)、
network_id
(uuid)、
public_ip
(字符串)、
record_type
(字符串)、
region_code
(字符串)、
status
(枚举值：created, provisioning, provisioned, deleting)、
updated_at
(字符串)

Create a Public Internet Gateway

创建公共互联网网关

Create a new Public Internet Gateway.
POST /public_internet_gateways
Optional: 
created_at
(string), 
id
(uuid), 
name
(string), 
network_id
(uuid), 
public_ip
(string), 
record_type
(string), 
region_code
(string), 
status
(enum: created, provisioning, provisioned, deleting), 
updated_at
(string)
ruby
public_internet_gateway = client.public_internet_gateways.create

puts(public_internet_gateway)
Returns: 
created_at
(string), 
id
(uuid), 
name
(string), 
network_id
(uuid), 
public_ip
(string), 
record_type
(string), 
region_code
(string), 
status
(enum: created, provisioning, provisioned, deleting), 
updated_at
(string)
创建一个新的公共互联网网关。
POST /public_internet_gateways
可选参数：
created_at
(字符串)、
id
(uuid)、
name
(字符串)、
network_id
(uuid)、
public_ip
(字符串)、
record_type
(字符串)、
region_code
(字符串)、
status
(枚举值：created, provisioning, provisioned, deleting)、
updated_at
(字符串)
ruby
public_internet_gateway = client.public_internet_gateways.create

puts(public_internet_gateway)
返回参数：
created_at
(字符串)、
id
(uuid)、
name
(字符串)、
network_id
(uuid)、
public_ip
(字符串)、
record_type
(字符串)、
region_code
(字符串)、
status
(枚举值：created, provisioning, provisioned, deleting)、
updated_at
(字符串)

Retrieve a Public Internet Gateway

获取公共互联网网关详情

Retrieve a Public Internet Gateway.
GET /public_internet_gateways/{id}
ruby
public_internet_gateway = client.public_internet_gateways.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(public_internet_gateway)
Returns: 
created_at
(string), 
id
(uuid), 
name
(string), 
network_id
(uuid), 
public_ip
(string), 
record_type
(string), 
region_code
(string), 
status
(enum: created, provisioning, provisioned, deleting), 
updated_at
(string)
获取指定公共互联网网关的详情。
GET /public_internet_gateways/{id}
ruby
public_internet_gateway = client.public_internet_gateways.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(public_internet_gateway)
返回参数：
created_at
(字符串)、
id
(uuid)、
name
(字符串)、
network_id
(uuid)、
public_ip
(字符串)、
record_type
(字符串)、
region_code
(字符串)、
status
(枚举值：created, provisioning, provisioned, deleting)、
updated_at
(字符串)

Delete a Public Internet Gateway

删除公共互联网网关

Delete a Public Internet Gateway.
DELETE /public_internet_gateways/{id}
ruby
public_internet_gateway = client.public_internet_gateways.delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(public_internet_gateway)
Returns: 
created_at
(string), 
id
(uuid), 
name
(string), 
network_id
(uuid), 
public_ip
(string), 
record_type
(string), 
region_code
(string), 
status
(enum: created, provisioning, provisioned, deleting), 
updated_at
(string)
删除指定公共互联网网关。
DELETE /public_internet_gateways/{id}
ruby
public_internet_gateway = client.public_internet_gateways.delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(public_internet_gateway)
返回参数：
created_at
(字符串)、
id
(uuid)、
name
(字符串)、
network_id
(uuid)、
public_ip
(字符串)、
record_type
(字符串)、
region_code
(字符串)、
status
(枚举值：created, provisioning, provisioned, deleting)、
updated_at
(字符串)

List all Regions

列出所有区域

List all regions and the interfaces that region supports
GET /regions
ruby
regions = client.regions.list

puts(regions)
Returns: 
code
(string), 
created_at
(string), 
name
(string), 
record_type
(string), 
supported_interfaces
(array[string]), 
updated_at
(string)
列出所有区域以及该区域支持的接口类型
GET /regions
ruby
regions = client.regions.list

puts(regions)
返回参数：
code
(字符串)、
created_at
(字符串)、
name
(字符串)、
record_type
(字符串)、
supported_interfaces
(字符串数组)、
updated_at
(字符串)

List all Virtual Cross Connects

列出所有虚拟交叉连接

List all Virtual Cross Connects.
GET /virtual_cross_connects
ruby
page = client.virtual_cross_connects.list

puts(page)
Returns: 
bandwidth_mbps
(number), 
bgp_asn
(number), 
cloud_provider
(enum: aws, azure, gce), 
cloud_provider_region
(string), 
created_at
(string), 
id
(uuid), 
name
(string), 
network_id
(uuid), 
primary_bgp_key
(string), 
primary_cloud_account_id
(string), 
primary_cloud_ip
(string), 
primary_enabled
(boolean), 
primary_routing_announcement
(boolean), 
primary_telnyx_ip
(string), 
record_type
(string), 
region
(object), 
region_code
(string), 
secondary_bgp_key
(string), 
secondary_cloud_account_id
(string), 
secondary_cloud_ip
(string), 
secondary_enabled
(boolean), 
secondary_routing_announcement
(boolean), 
secondary_telnyx_ip
(string), 
status
(enum: created, provisioning, provisioned, deleting), 
updated_at
(string)
列出所有虚拟交叉连接。
GET /virtual_cross_connects
ruby
page = client.virtual_cross_connects.list

puts(page)
返回参数：
bandwidth_mbps
(数字)、
bgp_asn
(数字)、
cloud_provider
(枚举值：aws, azure, gce)、
cloud_provider_region
(字符串)、
created_at
(字符串)、
id
(uuid)、
name
(字符串)、
network_id
(uuid)、
primary_bgp_key
(字符串)、
primary_cloud_account_id
(字符串)、
primary_cloud_ip
(字符串)、
primary_enabled
(布尔值)、
primary_routing_announcement
(布尔值)、
primary_telnyx_ip
(字符串)、
record_type
(字符串)、
region
(对象)、
region_code
(字符串)、
secondary_bgp_key
(字符串)、
secondary_cloud_account_id
(字符串)、
secondary_cloud_ip
(字符串)、
secondary_enabled
(布尔值)、
secondary_routing_announcement
(布尔值)、
secondary_telnyx_ip
(字符串)、
status
(枚举值：created, provisioning, provisioned, deleting)、
updated_at
(字符串)

Create a Virtual Cross Connect

创建虚拟交叉连接

Create a new Virtual Cross Connect. For AWS and GCE, you have the option of creating the primary connection first and the secondary connection later. You also have the option of disabling the primary and/or secondary connections at any time and later re-enabling them. With Azure, you do not have this option.
POST /virtual_cross_connects
— Required: 
network_id
, 
region_code
, 
cloud_provider
, 
cloud_provider_region
, 
bgp_asn
, 
primary_cloud_account_id
Optional: 
bandwidth_mbps
(number), 
created_at
(string), 
id
(uuid), 
name
(string), 
primary_bgp_key
(string), 
primary_cloud_ip
(string), 
primary_enabled
(boolean), 
primary_telnyx_ip
(string), 
record_type
(string), 
secondary_bgp_key
(string), 
secondary_cloud_account_id
(string), 
secondary_cloud_ip
(string), 
secondary_enabled
(boolean), 
secondary_telnyx_ip
(string), 
status
(enum: created, provisioning, provisioned, deleting), 
updated_at
(string)
ruby
virtual_cross_connect = client.virtual_cross_connects.create(region_code: "ashburn-va")

puts(virtual_cross_connect)
Returns: 
bandwidth_mbps
(number), 
bgp_asn
(number), 
cloud_provider
(enum: aws, azure, gce), 
cloud_provider_region
(string), 
created_at
(string), 
id
(uuid), 
name
(string), 
network_id
(uuid), 
primary_bgp_key
(string), 
primary_cloud_account_id
(string), 
primary_cloud_ip
(string), 
primary_enabled
(boolean), 
primary_routing_announcement
(boolean), 
primary_telnyx_ip
(string), 
record_type
(string), 
region
(object), 
region_code
(string), 
secondary_bgp_key
(string), 
secondary_cloud_account_id
(string), 
secondary_cloud_ip
(string), 
secondary_enabled
(boolean), 
secondary_routing_announcement
(boolean), 
secondary_telnyx_ip
(string), 
status
(enum: created, provisioning, provisioned, deleting), 
updated_at
(string)
创建一个新的虚拟交叉连接。对于AWS和GCE，你可以选择先创建主连接，之后再创建次连接，也可以随时禁用主连接和/或次连接，之后再重新启用。使用Azure时不支持该操作模式。
POST /virtual_cross_connects
— 必填参数：
network_id
、
region_code
、
cloud_provider
、
cloud_provider_region
、
bgp_asn
、
primary_cloud_account_id
可选参数：
bandwidth_mbps
(数字)、
created_at
(字符串)、
id
(uuid)、
name
(字符串)、
primary_bgp_key
(字符串)、
primary_cloud_ip
(字符串)、
primary_enabled
(布尔值)、
primary_telnyx_ip
(字符串)、
record_type
(字符串)、
secondary_bgp_key
(字符串)、
secondary_cloud_account_id
(字符串)、
secondary_cloud_ip
(字符串)、
secondary_enabled
(布尔值)、
secondary_telnyx_ip
(字符串)、
status
(枚举值：created, provisioning, provisioned, deleting)、
updated_at
(字符串)
ruby
virtual_cross_connect = client.virtual_cross_connects.create(region_code: "ashburn-va")

puts(virtual_cross_connect)
返回参数：
bandwidth_mbps
(数字)、
bgp_asn
(数字)、
cloud_provider
(枚举值：aws, azure, gce)、
cloud_provider_region
(字符串)、
created_at
(字符串)、
id
(uuid)、
name
(字符串)、
network_id
(uuid)、
primary_bgp_key
(字符串)、
primary_cloud_account_id
(字符串)、
primary_cloud_ip
(字符串)、
primary_enabled
(布尔值)、
primary_routing_announcement
(布尔值)、
primary_telnyx_ip
(字符串)、
record_type
(字符串)、
region
(对象)、
region_code
(字符串)、
secondary_bgp_key
(字符串)、
secondary_cloud_account_id
(字符串)、
secondary_cloud_ip
(字符串)、
secondary_enabled
(布尔值)、
secondary_routing_announcement
(布尔值)、
secondary_telnyx_ip
(字符串)、
status
(枚举值：created, provisioning, provisioned, deleting)、
updated_at
(字符串)

Retrieve a Virtual Cross Connect

获取虚拟交叉连接详情

Retrieve a Virtual Cross Connect.
GET /virtual_cross_connects/{id}
ruby
virtual_cross_connect = client.virtual_cross_connects.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(virtual_cross_connect)
Returns: 
bandwidth_mbps
(number), 
bgp_asn
(number), 
cloud_provider
(enum: aws, azure, gce), 
cloud_provider_region
(string), 
created_at
(string), 
id
(uuid), 
name
(string), 
network_id
(uuid), 
primary_bgp_key
(string), 
primary_cloud_account_id
(string), 
primary_cloud_ip
(string), 
primary_enabled
(boolean), 
primary_routing_announcement
(boolean), 
primary_telnyx_ip
(string), 
record_type
(string), 
region
(object), 
region_code
(string), 
secondary_bgp_key
(string), 
secondary_cloud_account_id
(string), 
secondary_cloud_ip
(string), 
secondary_enabled
(boolean), 
secondary_routing_announcement
(boolean), 
secondary_telnyx_ip
(string), 
status
(enum: created, provisioning, provisioned, deleting), 
updated_at
(string)
获取指定虚拟交叉连接的详情。
GET /virtual_cross_connects/{id}
ruby
virtual_cross_connect = client.virtual_cross_connects.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(virtual_cross_connect)
返回参数：
bandwidth_mbps
(数字)、
bgp_asn
(数字)、
cloud_provider
(枚举值：aws, azure, gce)、
cloud_provider_region
(字符串)、
created_at
(字符串)、
id
(uuid)、
name
(字符串)、
network_id
(uuid)、
primary_bgp_key
(字符串)、
primary_cloud_account_id
(字符串)、
primary_cloud_ip
(字符串)、
primary_enabled
(布尔值)、
primary_routing_announcement
(布尔值)、
primary_telnyx_ip
(字符串)、
record_type
(字符串)、
region
(对象)、
region_code
(字符串)、
secondary_bgp_key
(字符串)、
secondary_cloud_account_id
(字符串)、
secondary_cloud_ip
(字符串)、
secondary_enabled
(布尔值)、
secondary_routing_announcement
(布尔值)、
secondary_telnyx_ip
(字符串)、
status
(枚举值：created, provisioning, provisioned, deleting)、
updated_at
(字符串)

Update the Virtual Cross Connect

更新虚拟交叉连接

Update the Virtual Cross Connect. Cloud IPs can only be patched during the 
created
state, as GCE will only inform you of your generated IP once the pending connection requested has been accepted.
PATCH /virtual_cross_connects/{id}
Optional: 
primary_cloud_ip
(string), 
primary_enabled
(boolean), 
primary_routing_announcement
(boolean), 
secondary_cloud_ip
(string), 
secondary_enabled
(boolean), 
secondary_routing_announcement
(boolean)
ruby
virtual_cross_connect = client.virtual_cross_connects.update("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(virtual_cross_connect)
Returns: 
bandwidth_mbps
(number), 
bgp_asn
(number), 
cloud_provider
(enum: aws, azure, gce), 
cloud_provider_region
(string), 
created_at
(string), 
id
(uuid), 
name
(string), 
network_id
(uuid), 
primary_bgp_key
(string), 
primary_cloud_account_id
(string), 
primary_cloud_ip
(string), 
primary_enabled
(boolean), 
primary_routing_announcement
(boolean), 
primary_telnyx_ip
(string), 
record_type
(string), 
region
(object), 
region_code
(string), 
secondary_bgp_key
(string), 
secondary_cloud_account_id
(string), 
secondary_cloud_ip
(string), 
secondary_enabled
(boolean), 
secondary_routing_announcement
(boolean), 
secondary_telnyx_ip
(string), 
status
(enum: created, provisioning, provisioned, deleting), 
updated_at
(string)
更新指定虚拟交叉连接的信息。云IP仅能在
created
状态下修改，因为GCE只会在待处理的连接请求被接受后，才会返回生成的IP地址。
PATCH /virtual_cross_connects/{id}
可选参数：
primary_cloud_ip
(字符串)、
primary_enabled
(布尔值)、
primary_routing_announcement
(布尔值)、
secondary_cloud_ip
(字符串)、
secondary_enabled
(布尔值)、
secondary_routing_announcement
(布尔值)
ruby
virtual_cross_connect = client.virtual_cross_connects.update("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(virtual_cross_connect)
返回参数：
bandwidth_mbps
(数字)、
bgp_asn
(数字)、
cloud_provider
(枚举值：aws, azure, gce)、
cloud_provider_region
(字符串)、
created_at
(字符串)、
id
(uuid)、
name
(字符串)、
network_id
(uuid)、
primary_bgp_key
(字符串)、
primary_cloud_account_id
(字符串)、
primary_cloud_ip
(字符串)、
primary_enabled
(布尔值)、
primary_routing_announcement
(布尔值)、
primary_telnyx_ip
(字符串)、
record_type
(字符串)、
region
(对象)、
region_code
(字符串)、
secondary_bgp_key
(字符串)、
secondary_cloud_account_id
(字符串)、
secondary_cloud_ip
(字符串)、
secondary_enabled
(布尔值)、
secondary_routing_announcement
(布尔值)、
secondary_telnyx_ip
(字符串)、
status
(枚举值：created, provisioning, provisioned, deleting)、
updated_at
(字符串)

Delete a Virtual Cross Connect

删除虚拟交叉连接

Delete a Virtual Cross Connect.
DELETE /virtual_cross_connects/{id}
ruby
virtual_cross_connect = client.virtual_cross_connects.delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(virtual_cross_connect)
Returns: 
bandwidth_mbps
(number), 
bgp_asn
(number), 
cloud_provider
(enum: aws, azure, gce), 
cloud_provider_region
(string), 
created_at
(string), 
id
(uuid), 
name
(string), 
network_id
(uuid), 
primary_bgp_key
(string), 
primary_cloud_account_id
(string), 
primary_cloud_ip
(string), 
primary_enabled
(boolean), 
primary_routing_announcement
(boolean), 
primary_telnyx_ip
(string), 
record_type
(string), 
region
(object), 
region_code
(string), 
secondary_bgp_key
(string), 
secondary_cloud_account_id
(string), 
secondary_cloud_ip
(string), 
secondary_enabled
(boolean), 
secondary_routing_announcement
(boolean), 
secondary_telnyx_ip
(string), 
status
(enum: created, provisioning, provisioned, deleting), 
updated_at
(string)
删除指定虚拟交叉连接。
DELETE /virtual_cross_connects/{id}
ruby
virtual_cross_connect = client.virtual_cross_connects.delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(virtual_cross_connect)
返回参数：
bandwidth_mbps
(数字)、
bgp_asn
(数字)、
cloud_provider
(枚举值：aws, azure, gce)、
cloud_provider_region
(字符串)、
created_at
(字符串)、
id
(uuid)、
name
(字符串)、
network_id
(uuid)、
primary_bgp_key
(字符串)、
primary_cloud_account_id
(字符串)、
primary_cloud_ip
(字符串)、
primary_enabled
(布尔值)、
primary_routing_announcement
(布尔值)、
primary_telnyx_ip
(字符串)、
record_type
(字符串)、
region
(对象)、
region_code
(字符串)、
secondary_bgp_key
(字符串)、
secondary_cloud_account_id
(字符串)、
secondary_cloud_ip
(字符串)、
secondary_enabled
(布尔值)、
secondary_routing_announcement
(布尔值)、
secondary_telnyx_ip
(字符串)、
status
(枚举值：created, provisioning, provisioned, deleting)、
updated_at
(字符串)

List Virtual Cross Connect Cloud Coverage

列出虚拟交叉连接云覆盖区域

List Virtual Cross Connects Cloud Coverage. This endpoint shows which cloud regions are available for the 
location_code
your Virtual Cross Connect will be provisioned in.
GET /virtual_cross_connects_coverage
ruby
page = client.virtual_cross_connects_coverage.list

puts(page)
Returns: 
available_bandwidth
(array[number]), 
cloud_provider
(enum: aws, azure, gce), 
cloud_provider_region
(string), 
location
(object), 
record_type
(string)
列出虚拟交叉连接的云覆盖区域。该接口会返回虚拟交叉连接将要部署的
location_code
对应的可用云区域。
GET /virtual_cross_connects_coverage
ruby
page = client.virtual_cross_connects_coverage.list

puts(page)
返回参数：
available_bandwidth
(数字数组)、
cloud_provider
(枚举值：aws, azure, gce)、
cloud_provider_region
(字符串)、
location
(对象)、
record_type
(字符串)

List all WireGuard Interfaces

列出所有WireGuard接口

List all WireGuard Interfaces.
GET /wireguard_interfaces
ruby
page = client.wireguard_interfaces.list

puts(page)
Returns: 
created_at
(string), 
enable_sip_trunking
(boolean), 
endpoint
(string), 
id
(uuid), 
name
(string), 
network_id
(uuid), 
public_key
(string), 
record_type
(string), 
region
(object), 
region_code
(string), 
status
(enum: created, provisioning, provisioned, deleting), 
updated_at
(string)
列出所有WireGuard接口。
GET /wireguard_interfaces
ruby
page = client.wireguard_interfaces.list

puts(page)
返回参数：
created_at
(字符串)、
enable_sip_trunking
(布尔值)、
endpoint
(字符串)、
id
(uuid)、
name
(字符串)、
network_id
(uuid)、
public_key
(字符串)、
record_type
(字符串)、
region
(对象)、
region_code
(字符串)、
status
(枚举值：created, provisioning, provisioned, deleting)、
updated_at
(字符串)

Create a WireGuard Interface

创建WireGuard接口

Create a new WireGuard Interface. Current limitation of 10 interfaces per user can be created.
POST /wireguard_interfaces
— Required: 
network_id
, 
region_code
Optional: 
created_at
(string), 
enable_sip_trunking
(boolean), 
endpoint
(string), 
id
(uuid), 
name
(string), 
public_key
(string), 
record_type
(string), 
status
(enum: created, provisioning, provisioned, deleting), 
updated_at
(string)
ruby
wireguard_interface = client.wireguard_interfaces.create(region_code: "ashburn-va")

puts(wireguard_interface)
Returns: 
created_at
(string), 
enable_sip_trunking
(boolean), 
endpoint
(string), 
id
(uuid), 
name
(string), 
network_id
(uuid), 
public_key
(string), 
record_type
(string), 
region
(object), 
region_code
(string), 
status
(enum: created, provisioning, provisioned, deleting), 
updated_at
(string)
创建一个新的WireGuard接口。当前限制每个用户最多创建10个接口。
POST /wireguard_interfaces
— 必填参数：
network_id
、
region_code
可选参数：
created_at
(字符串)、
enable_sip_trunking
(布尔值)、
endpoint
(字符串)、
id
(uuid)、
name
(字符串)、
public_key
(字符串)、
record_type
(字符串)、
status
(枚举值：created, provisioning, provisioned, deleting)、
updated_at
(字符串)
ruby
wireguard_interface = client.wireguard_interfaces.create(region_code: "ashburn-va")

puts(wireguard_interface)
返回参数：
created_at
(字符串)、
enable_sip_trunking
(布尔值)、
endpoint
(字符串)、
id
(uuid)、
name
(字符串)、
network_id
(uuid)、
public_key
(字符串)、
record_type
(字符串)、
region
(对象)、
region_code
(字符串)、
status
(枚举值：created, provisioning, provisioned, deleting)、
updated_at
(字符串)

Retrieve a WireGuard Interfaces

获取WireGuard接口详情

Retrieve a WireGuard Interfaces.
GET /wireguard_interfaces/{id}
ruby
wireguard_interface = client.wireguard_interfaces.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(wireguard_interface)
Returns: 
created_at
(string), 
enable_sip_trunking
(boolean), 
endpoint
(string), 
id
(uuid), 
name
(string), 
network_id
(uuid), 
public_key
(string), 
record_type
(string), 
region
(object), 
region_code
(string), 
status
(enum: created, provisioning, provisioned, deleting), 
updated_at
(string)
获取指定WireGuard接口的详情。
GET /wireguard_interfaces/{id}
ruby
wireguard_interface = client.wireguard_interfaces.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(wireguard_interface)
返回参数：
created_at
(字符串)、
enable_sip_trunking
(布尔值)、
endpoint
(字符串)、
id
(uuid)、
name
(字符串)、
network_id
(uuid)、
public_key
(字符串)、
record_type
(字符串)、
region
(对象)、
region_code
(字符串)、
status
(枚举值：created, provisioning, provisioned, deleting)、
updated_at
(字符串)

Delete a WireGuard Interface

删除WireGuard接口

Delete a WireGuard Interface.
DELETE /wireguard_interfaces/{id}
ruby
wireguard_interface = client.wireguard_interfaces.delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(wireguard_interface)
Returns: 
created_at
(string), 
enable_sip_trunking
(boolean), 
endpoint
(string), 
id
(uuid), 
name
(string), 
network_id
(uuid), 
public_key
(string), 
record_type
(string), 
region
(object), 
region_code
(string), 
status
(enum: created, provisioning, provisioned, deleting), 
updated_at
(string)
删除指定WireGuard接口。
DELETE /wireguard_interfaces/{id}
ruby
wireguard_interface = client.wireguard_interfaces.delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(wireguard_interface)
返回参数：
created_at
(字符串)、
enable_sip_trunking
(布尔值)、
endpoint
(字符串)、
id
(uuid)、
name
(字符串)、
network_id
(uuid)、
public_key
(字符串)、
record_type
(字符串)、
region
(对象)、
region_code
(字符串)、
status
(枚举值：created, provisioning, provisioned, deleting)、
updated_at
(字符串)

List all WireGuard Peers

列出所有WireGuard对等节点

List all WireGuard peers.
GET /wireguard_peers
ruby
page = client.wireguard_peers.list

puts(page)
Returns: 
created_at
(string), 
id
(uuid), 
last_seen
(string), 
private_key
(string), 
public_key
(string), 
record_type
(string), 
updated_at
(string), 
wireguard_interface_id
(uuid)
列出所有WireGuard对等节点。
GET /wireguard_peers
ruby
page = client.wireguard_peers.list

puts(page)
返回参数：
created_at
(字符串)、
id
(uuid)、
last_seen
(字符串)、
private_key
(字符串)、
public_key
(字符串)、
record_type
(字符串)、
updated_at
(字符串)、
wireguard_interface_id
(uuid)

Create a WireGuard Peer

创建WireGuard对等节点

Create a new WireGuard Peer. Current limitation of 5 peers per interface can be created.
POST /wireguard_peers
— Required: 
wireguard_interface_id
Optional: 
created_at
(string), 
id
(uuid), 
last_seen
(string), 
private_key
(string), 
public_key
(string), 
record_type
(string), 
updated_at
(string)
ruby
wireguard_peer = client.wireguard_peers.create(wireguard_interface_id: "6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(wireguard_peer)
Returns: 
created_at
(string), 
id
(uuid), 
last_seen
(string), 
private_key
(string), 
public_key
(string), 
record_type
(string), 
updated_at
(string), 
wireguard_interface_id
(uuid)
创建一个新的WireGuard对等节点。当前限制每个接口最多创建5个对等节点。
POST /wireguard_peers
— 必填参数：
wireguard_interface_id
可选参数：
created_at
(字符串)、
id
(uuid)、
last_seen
(字符串)、
private_key
(字符串)、
public_key
(字符串)、
record_type
(字符串)、
updated_at
(字符串)
ruby
wireguard_peer = client.wireguard_peers.create(wireguard_interface_id: "6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(wireguard_peer)
返回参数：
created_at
(字符串)、
id
(uuid)、
last_seen
(字符串)、
private_key
(字符串)、
public_key
(字符串)、
record_type
(字符串)、
updated_at
(字符串)、
wireguard_interface_id
(uuid)

Retrieve the WireGuard Peer

获取WireGuard对等节点详情

Retrieve the WireGuard peer.
GET /wireguard_peers/{id}
ruby
wireguard_peer = client.wireguard_peers.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(wireguard_peer)
Returns: 
created_at
(string), 
id
(uuid), 
last_seen
(string), 
private_key
(string), 
public_key
(string), 
record_type
(string), 
updated_at
(string), 
wireguard_interface_id
(uuid)
获取指定WireGuard对等节点的详情。
GET /wireguard_peers/{id}
ruby
wireguard_peer = client.wireguard_peers.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(wireguard_peer)
返回参数：
created_at
(字符串)、
id
(uuid)、
last_seen
(字符串)、
private_key
(字符串)、
public_key
(字符串)、
record_type
(字符串)、
updated_at
(字符串)、
wireguard_interface_id
(uuid)

Update the WireGuard Peer

更新WireGuard对等节点

Update the WireGuard peer.
PATCH /wireguard_peers/{id}
Optional: 
public_key
(string)
ruby
wireguard_peer = client.wireguard_peers.update("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(wireguard_peer)
Returns: 
created_at
(string), 
id
(uuid), 
last_seen
(string), 
private_key
(string), 
public_key
(string), 
record_type
(string), 
updated_at
(string), 
wireguard_interface_id
(uuid)
更新指定WireGuard对等节点的信息。
PATCH /wireguard_peers/{id}
可选参数：
public_key
(字符串)
ruby
wireguard_peer = client.wireguard_peers.update("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(wireguard_peer)
返回参数：
created_at
(字符串)、
id
(uuid)、
last_seen
(字符串)、
private_key
(字符串)、
public_key
(字符串)、
record_type
(字符串)、
updated_at
(字符串)、
wireguard_interface_id
(uuid)

Delete the WireGuard Peer

删除WireGuard对等节点

Delete the WireGuard peer.
DELETE /wireguard_peers/{id}
ruby
wireguard_peer = client.wireguard_peers.delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(wireguard_peer)
Returns: 
created_at
(string), 
id
(uuid), 
last_seen
(string), 
private_key
(string), 
public_key
(string), 
record_type
(string), 
updated_at
(string), 
wireguard_interface_id
(uuid)
删除指定WireGuard对等节点。
DELETE /wireguard_peers/{id}
ruby
wireguard_peer = client.wireguard_peers.delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(wireguard_peer)
返回参数：
created_at
(字符串)、
id
(uuid)、
last_seen
(字符串)、
private_key
(字符串)、
public_key
(字符串)、
record_type
(字符串)、
updated_at
(字符串)、
wireguard_interface_id
(uuid)

Retrieve Wireguard config template for Peer

获取对等节点的Wireguard配置模板

GET /wireguard_peers/{id}/config
ruby
response = client.wireguard_peers.retrieve_config("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(response)
GET /wireguard_peers/{id}/config
ruby
response = client.wireguard_peers.retrieve_config("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(response)