Back to Details

telnyx-networking-python

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

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

Telnyx Networking - Python

Telnyx 网络服务 - Python

Installation

安装

bash
pip install telnyx
bash
pip install telnyx

Setup

初始化设置

python
import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
All examples below assume 
client
is already initialized as shown above.
python
import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("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:
python
import telnyx

try:
    result = client.messages.send(to="+13125550001", from_="+13125550002", text="Hello")
except telnyx.APIConnectionError:
    print("Network error — check connectivity and retry")
except telnyx.RateLimitError:
    # 429: rate limited — wait and retry with exponential backoff
    import time
    time.sleep(1)  # Check Retry-After header for actual delay
except telnyx.APIStatusError as e:
    print(f"API error {e.status_code}: {e.message}")
    if e.status_code == 422:
        print("Validation error — check required fields and formats")
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)。生产环境代码请务必做好错误处理：
python
import telnyx

try:
    result = client.messages.send(to="+13125550001", from_="+13125550002", text="Hello")
except telnyx.APIConnectionError:
    print("网络错误 — 检查网络连接后重试")
except telnyx.RateLimitError:
    # 429: 触发速率限制 — 等待后使用指数退避策略重试
    import time
    time.sleep(1)  # 可查看Retry-After响应头获取实际需要等待的时间
except telnyx.APIStatusError as e:
    print(f"API错误 {e.status_code}: {e.message}")
    if e.status_code == 422:
        print("校验错误 — 检查必填字段和格式是否正确")
常见错误码：
401
API密钥无效，
403
权限不足，
404
资源不存在，
422
校验错误（检查字段格式），
429
触发速率限制（使用指数退避策略重试）。

Important Notes

重要说明

  • Pagination: List methods return an auto-paginating iterator. Use 
    for item in page_result:
    to iterate through all pages automatically.
  • 分页： 列表类方法会返回支持自动分页的迭代器。使用
    for item in page_result:
    即可自动遍历所有分页的内容。

List all clusters

列出所有集群

GET /ai/clusters
python
page = client.ai.clusters.list()
page = page.data[0]
print(page.task_id)
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
python
page = client.ai.clusters.list()
page = page.data[0]
print(page.task_id)
返回参数：
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)
python
response = client.ai.clusters.compute(
    bucket="my-bucket",
)
print(response.data)
Returns: 
task_id
(string)
启动后台任务，计算嵌入式存储桶中的数据的聚类方式，可用于识别数据中的常见主题和模式。
POST /ai/clusters
— 必填参数：
bucket
可选参数：
files
(字符串数组)、
min_cluster_size
(整数)、
min_subcluster_size
(整数)、
prefix
(字符串)
python
response = client.ai.clusters.compute(
    bucket="my-bucket",
)
print(response.data)
返回参数：
task_id
(字符串)

Fetch a cluster

查询单个集群

GET /ai/clusters/{task_id}
python
cluster = client.ai.clusters.retrieve(
    task_id="550e8400-e29b-41d4-a716-446655440000",
)
print(cluster.data)
Returns: 
bucket
(string), 
clusters
(array[object]), 
status
(enum: pending, starting, running, completed, failed)
GET /ai/clusters/{task_id}
python
cluster = client.ai.clusters.retrieve(
    task_id="550e8400-e29b-41d4-a716-446655440000",
)
print(cluster.data)
返回参数：
bucket
(字符串)、
clusters
(对象数组)、
status
(枚举值：pending待处理、starting启动中、running运行中、completed已完成、failed失败)

Delete a cluster

删除集群

DELETE /ai/clusters/{task_id}
python
client.ai.clusters.delete(
    "task_id",
)
DELETE /ai/clusters/{task_id}
python
client.ai.clusters.delete(
    "task_id",
)

Fetch a cluster visualization

获取集群可视化数据

GET /ai/clusters/{task_id}/graph
python
response = client.ai.clusters.fetch_graph(
    task_id="550e8400-e29b-41d4-a716-446655440000",
)
print(response)
content = response.read()
print(content)
GET /ai/clusters/{task_id}/graph
python
response = client.ai.clusters.fetch_graph(
    task_id="550e8400-e29b-41d4-a716-446655440000",
)
print(response)
content = response.read()
print(content)

List Integrations

列出所有集成

List all available integrations.
GET /ai/integrations
python
integrations = client.ai.integrations.list()
print(integrations.data)
Returns: 
available_tools
(array[string]), 
description
(string), 
display_name
(string), 
id
(string), 
logo_url
(string), 
name
(string), 
status
(enum: disconnected, connected)
列出所有可用的集成。
GET /ai/integrations
python
integrations = client.ai.integrations.list()
print(integrations.data)
返回参数：
available_tools
(字符串数组)、
description
(字符串)、
display_name
(字符串)、
id
(字符串)、
logo_url
(字符串)、
name
(字符串)、
status
(枚举值：disconnected未连接、connected已连接)

List User Integrations

列出用户集成

List user setup integrations
GET /ai/integrations/connections
python
connections = client.ai.integrations.connections.list()
print(connections.data)
Returns: 
allowed_tools
(array[string]), 
id
(string), 
integration_id
(string)
列出用户已配置的集成
GET /ai/integrations/connections
python
connections = client.ai.integrations.connections.list()
print(connections.data)
返回参数：
allowed_tools
(字符串数组)、
id
(字符串)、
integration_id
(字符串)

Get User Integration connection By Id

根据ID查询用户集成连接

Get user setup integrations
GET /ai/integrations/connections/{user_connection_id}
python
connection = client.ai.integrations.connections.retrieve(
    "user_connection_id",
)
print(connection.data)
Returns: 
allowed_tools
(array[string]), 
id
(string), 
integration_id
(string)
查询用户已配置的集成
GET /ai/integrations/connections/{user_connection_id}
python
connection = client.ai.integrations.connections.retrieve(
    "user_connection_id",
)
print(connection.data)
返回参数：
allowed_tools
(字符串数组)、
id
(字符串)、
integration_id
(字符串)

Delete Integration Connection

删除集成连接

Delete a specific integration connection.
DELETE /ai/integrations/connections/{user_connection_id}
python
client.ai.integrations.connections.delete(
    "user_connection_id",
)
删除指定的集成连接。
DELETE /ai/integrations/connections/{user_connection_id}
python
client.ai.integrations.connections.delete(
    "user_connection_id",
)

List Integration By Id

根据ID查询集成

Retrieve integration details
GET /ai/integrations/{integration_id}
python
integration = client.ai.integrations.retrieve(
    "integration_id",
)
print(integration.id)
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}
python
integration = client.ai.integrations.retrieve(
    "integration_id",
)
print(integration.id)
返回参数：
available_tools
(字符串数组)、
description
(字符串)、
display_name
(字符串)、
id
(字符串)、
logo_url
(字符串)、
name
(字符串)、
status
(枚举值：disconnected未连接、connected已连接)

List all Global IP Allowed Ports

列出所有全局IP允许端口

GET /global_ip_allowed_ports
python
global_ip_allowed_ports = client.global_ip_allowed_ports.list()
print(global_ip_allowed_ports.data)
Returns: 
first_port
(integer), 
id
(uuid), 
last_port
(integer), 
name
(string), 
protocol_code
(string), 
record_type
(string)
GET /global_ip_allowed_ports
python
global_ip_allowed_ports = client.global_ip_allowed_ports.list()
print(global_ip_allowed_ports.data)
返回参数：
first_port
(整数)、
id
(uuid)、
last_port
(整数)、
name
(字符串)、
protocol_code
(字符串)、
record_type
(字符串)

Global IP Assignment Health Check Metrics

全局IP分配健康检查指标

GET /global_ip_assignment_health
python
global_ip_assignment_health = client.global_ip_assignment_health.retrieve()
print(global_ip_assignment_health.data)
Returns: 
global_ip
(object), 
global_ip_assignment
(object), 
health
(object), 
timestamp
(date-time)
GET /global_ip_assignment_health
python
global_ip_assignment_health = client.global_ip_assignment_health.retrieve()
print(global_ip_assignment_health.data)
返回参数：
global_ip
(对象)、
global_ip_assignment
(对象)、
health
(对象)、
timestamp
(日期时间)

List all Global IP assignments

列出所有全局IP分配记录

List all Global IP assignments.
GET /global_ip_assignments
python
page = client.global_ip_assignments.list()
page = page.data[0]
print(page.id)
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
python
page = client.global_ip_assignments.list()
page = page.data[0]
print(page.id)
返回参数：
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)
python
global_ip_assignment = client.global_ip_assignments.create()
print(global_ip_assignment.data)
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)
python
global_ip_assignment = client.global_ip_assignments.create()
print(global_ip_assignment.data)
返回参数：
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}
python
global_ip_assignment = client.global_ip_assignments.retrieve(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(global_ip_assignment.data)
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}
python
global_ip_assignment = client.global_ip_assignments.retrieve(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(global_ip_assignment.data)
返回参数：
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)
python
global_ip_assignment = client.global_ip_assignments.update(
    global_ip_assignment_id="6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    global_ip_assignment_update_request={},
)
print(global_ip_assignment.data)
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
(字符串)
python
global_ip_assignment = client.global_ip_assignments.update(
    global_ip_assignment_id="6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    global_ip_assignment_update_request={},
)
print(global_ip_assignment.data)
返回参数：
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}
python
global_ip_assignment = client.global_ip_assignments.delete(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(global_ip_assignment.data)
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}
python
global_ip_assignment = client.global_ip_assignments.delete(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(global_ip_assignment.data)
返回参数：
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
python
global_ip_assignments_usage = client.global_ip_assignments_usage.retrieve()
print(global_ip_assignments_usage.data)
Returns: 
global_ip
(object), 
global_ip_assignment
(object), 
received
(object), 
timestamp
(date-time), 
transmitted
(object)
GET /global_ip_assignments_usage
python
global_ip_assignments_usage = client.global_ip_assignments_usage.retrieve()
print(global_ip_assignments_usage.data)
返回参数：
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
python
global_ip_health_check_types = client.global_ip_health_check_types.list()
print(global_ip_health_check_types.data)
Returns: 
health_check_params
(object), 
health_check_type
(string), 
record_type
(string)
列出所有全局IP健康检查类型。
GET /global_ip_health_check_types
python
global_ip_health_check_types = client.global_ip_health_check_types.list()
print(global_ip_health_check_types.data)
返回参数：
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
python
page = client.global_ip_health_checks.list()
page = page.data[0]
print(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
python
page = client.global_ip_health_checks.list()
page = page.data[0]
print(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)
python
global_ip_health_check = client.global_ip_health_checks.create()
print(global_ip_health_check.data)
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
(字符串)
python
global_ip_health_check = client.global_ip_health_checks.create()
print(global_ip_health_check.data)
返回参数：
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}
python
global_ip_health_check = client.global_ip_health_checks.retrieve(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(global_ip_health_check.data)
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}
python
global_ip_health_check = client.global_ip_health_checks.retrieve(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(global_ip_health_check.data)
返回参数：
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}
python
global_ip_health_check = client.global_ip_health_checks.delete(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(global_ip_health_check.data)
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}
python
global_ip_health_check = client.global_ip_health_checks.delete(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(global_ip_health_check.data)
返回参数：
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
python
global_ip_latency = client.global_ip_latency.retrieve()
print(global_ip_latency.data)
Returns: 
global_ip
(object), 
mean_latency
(object), 
percentile_latency
(object), 
prober_location
(object), 
timestamp
(date-time)
GET /global_ip_latency
python
global_ip_latency = client.global_ip_latency.retrieve()
print(global_ip_latency.data)
返回参数：
global_ip
(对象)、
mean_latency
(对象)、
percentile_latency
(对象)、
prober_location
(对象)、
timestamp
(日期时间)

List all Global IP Protocols

列出所有全局IP协议

GET /global_ip_protocols
python
global_ip_protocols = client.global_ip_protocols.list()
print(global_ip_protocols.data)
Returns: 
code
(string), 
name
(string), 
record_type
(string)
GET /global_ip_protocols
python
global_ip_protocols = client.global_ip_protocols.list()
print(global_ip_protocols.data)
返回参数：
code
(字符串)、
name
(字符串)、
record_type
(字符串)

Global IP Usage Metrics

全局IP使用指标

GET /global_ip_usage
python
global_ip_usage = client.global_ip_usage.retrieve()
print(global_ip_usage.data)
Returns: 
global_ip
(object), 
received
(object), 
timestamp
(date-time), 
transmitted
(object)
GET /global_ip_usage
python
global_ip_usage = client.global_ip_usage.retrieve()
print(global_ip_usage.data)
返回参数：
global_ip
(对象)、
received
(对象)、
timestamp
(日期时间)、
transmitted
(对象)

List all Global IPs

列出所有全局IP

List all Global IPs.
GET /global_ips
python
page = client.global_ips.list()
page = page.data[0]
print(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
python
page = client.global_ips.list()
page = page.data[0]
print(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)
python
global_ip = client.global_ips.create()
print(global_ip.data)
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
(字符串)
python
global_ip = client.global_ips.create()
print(global_ip.data)
返回参数：
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}
python
global_ip = client.global_ips.retrieve(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(global_ip.data)
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}
python
global_ip = client.global_ips.retrieve(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(global_ip.data)
返回参数：
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}
python
global_ip = client.global_ips.delete(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(global_ip.data)
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}
python
global_ip = client.global_ips.delete(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(global_ip.data)
返回参数：
created_at
(字符串)、
description
(字符串)、
id
(uuid)、
ip_address
(字符串)、
name
(字符串)、
ports
(对象)、
record_type
(字符串)、
updated_at
(字符串)

List all Networks

列出所有网络

List all Networks.
GET /networks
python
page = client.networks.list()
page = page.data[0]
print(page)
Returns: 
created_at
(string), 
id
(uuid), 
name
(string), 
record_type
(string), 
updated_at
(string)
列出所有网络。
GET /networks
python
page = client.networks.list()
page = page.data[0]
print(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)
python
network = client.networks.create(
    name="test network",
)
print(network.data)
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
(字符串)
python
network = client.networks.create(
    name="test network",
)
print(network.data)
返回参数：
created_at
(字符串)、
id
(uuid)、
name
(字符串)、
record_type
(字符串)、
updated_at
(字符串)

Retrieve a Network

查询单个网络

Retrieve a Network.
GET /networks/{id}
python
network = client.networks.retrieve(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(network.data)
Returns: 
created_at
(string), 
id
(uuid), 
name
(string), 
record_type
(string), 
updated_at
(string)
查询网络。
GET /networks/{id}
python
network = client.networks.retrieve(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(network.data)
返回参数：
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)
python
network = client.networks.update(
    network_id="6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    name="test network",
)
print(network.data)
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
(字符串)
python
network = client.networks.update(
    network_id="6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    name="test network",
)
print(network.data)
返回参数：
created_at
(字符串)、
id
(uuid)、
name
(字符串)、
record_type
(字符串)、
updated_at
(字符串)

Delete a Network

删除网络

Delete a Network.
DELETE /networks/{id}
python
network = client.networks.delete(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(network.data)
Returns: 
created_at
(string), 
id
(uuid), 
name
(string), 
record_type
(string), 
updated_at
(string)
删除网络。
DELETE /networks/{id}
python
network = client.networks.delete(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(network.data)
返回参数：
created_at
(字符串)、
id
(uuid)、
name
(字符串)、
record_type
(字符串)、
updated_at
(字符串)

Get Default Gateway status.

查询默认网关状态

GET /networks/{id}/default_gateway
python
default_gateway = client.networks.default_gateway.retrieve(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(default_gateway.data)
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
python
default_gateway = client.networks.default_gateway.retrieve(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(default_gateway.data)
返回参数：
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)
python
default_gateway = client.networks.default_gateway.create(
    network_identifier="6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(default_gateway.data)
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)
python
default_gateway = client.networks.default_gateway.create(
    network_identifier="6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(default_gateway.data)
返回参数：
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
python
default_gateway = client.networks.default_gateway.delete(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(default_gateway.data)
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
python
default_gateway = client.networks.default_gateway.delete(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(default_gateway.data)
返回参数：
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
python
page = client.networks.list_interfaces(
    id="6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
page = page.data[0]
print(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
python
page = client.networks.list_interfaces(
    id="6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
page = page.data[0]
print(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
python
page = client.private_wireless_gateways.list()
page = page.data[0]
print(page.id)
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
python
page = client.private_wireless_gateways.list()
page = page.data[0]
print(page.id)
返回参数：
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)
python
private_wireless_gateway = client.private_wireless_gateways.create(
    name="My private wireless gateway",
    network_id="6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(private_wireless_gateway.data)
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
(字符串)
python
private_wireless_gateway = client.private_wireless_gateways.create(
    name="My private wireless gateway",
    network_id="6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(private_wireless_gateway.data)
返回参数：
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}
python
private_wireless_gateway = client.private_wireless_gateways.retrieve(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(private_wireless_gateway.data)
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}
python
private_wireless_gateway = client.private_wireless_gateways.retrieve(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(private_wireless_gateway.data)
返回参数：
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}
python
private_wireless_gateway = client.private_wireless_gateways.delete(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(private_wireless_gateway.data)
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}
python
private_wireless_gateway = client.private_wireless_gateways.delete(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(private_wireless_gateway.data)
返回参数：
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
python
page = client.public_internet_gateways.list()
page = page.data[0]
print(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
python
page = client.public_internet_gateways.list()
page = page.data[0]
print(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)
python
public_internet_gateway = client.public_internet_gateways.create()
print(public_internet_gateway.data)
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
(字符串)
python
public_internet_gateway = client.public_internet_gateways.create()
print(public_internet_gateway.data)
返回参数：
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}
python
public_internet_gateway = client.public_internet_gateways.retrieve(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(public_internet_gateway.data)
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}
python
public_internet_gateway = client.public_internet_gateways.retrieve(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(public_internet_gateway.data)
返回参数：
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}
python
public_internet_gateway = client.public_internet_gateways.delete(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(public_internet_gateway.data)
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}
python
public_internet_gateway = client.public_internet_gateways.delete(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(public_internet_gateway.data)
返回参数：
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
python
regions = client.regions.list()
print(regions.data)
Returns: 
code
(string), 
created_at
(string), 
name
(string), 
record_type
(string), 
supported_interfaces
(array[string]), 
updated_at
(string)
列出所有区域以及该区域支持的接口
GET /regions
python
regions = client.regions.list()
print(regions.data)
返回参数：
code
(字符串)、
created_at
(字符串)、
name
(字符串)、
record_type
(字符串)、
supported_interfaces
(字符串数组)、
updated_at
(字符串)

List all Virtual Cross Connects

列出所有虚拟交叉连接

List all Virtual Cross Connects.
GET /virtual_cross_connects
python
page = client.virtual_cross_connects.list()
page = page.data[0]
print(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
python
page = client.virtual_cross_connects.list()
page = page.data[0]
print(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)
python
virtual_cross_connect = client.virtual_cross_connects.create(
    region_code="ashburn-va",
)
print(virtual_cross_connect.data)
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
(字符串)
python
virtual_cross_connect = client.virtual_cross_connects.create(
    region_code="ashburn-va",
)
print(virtual_cross_connect.data)
返回参数：
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}
python
virtual_cross_connect = client.virtual_cross_connects.retrieve(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(virtual_cross_connect.data)
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}
python
virtual_cross_connect = client.virtual_cross_connects.retrieve(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(virtual_cross_connect.data)
返回参数：
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)
python
virtual_cross_connect = client.virtual_cross_connects.update(
    id="6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(virtual_cross_connect.data)
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
(布尔值)
python
virtual_cross_connect = client.virtual_cross_connects.update(
    id="6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(virtual_cross_connect.data)
返回参数：
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}
python
virtual_cross_connect = client.virtual_cross_connects.delete(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(virtual_cross_connect.data)
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}
python
virtual_cross_connect = client.virtual_cross_connects.delete(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(virtual_cross_connect.data)
返回参数：
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
python
page = client.virtual_cross_connects_coverage.list()
page = page.data[0]
print(page.available_bandwidth)
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
python
page = client.virtual_cross_connects_coverage.list()
page = page.data[0]
print(page.available_bandwidth)
返回参数：
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
python
page = client.wireguard_interfaces.list()
page = page.data[0]
print(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
python
page = client.wireguard_interfaces.list()
page = page.data[0]
print(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)
python
wireguard_interface = client.wireguard_interfaces.create(
    region_code="ashburn-va",
)
print(wireguard_interface.data)
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
(字符串)
python
wireguard_interface = client.wireguard_interfaces.create(
    region_code="ashburn-va",
)
print(wireguard_interface.data)
返回参数：
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}
python
wireguard_interface = client.wireguard_interfaces.retrieve(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(wireguard_interface.data)
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}
python
wireguard_interface = client.wireguard_interfaces.retrieve(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(wireguard_interface.data)
返回参数：
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}
python
wireguard_interface = client.wireguard_interfaces.delete(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(wireguard_interface.data)
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}
python
wireguard_interface = client.wireguard_interfaces.delete(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(wireguard_interface.data)
返回参数：
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
python
page = client.wireguard_peers.list()
page = page.data[0]
print(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
python
page = client.wireguard_peers.list()
page = page.data[0]
print(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)
python
wireguard_peer = client.wireguard_peers.create(
    wireguard_interface_id="6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(wireguard_peer.data)
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
(字符串)
python
wireguard_peer = client.wireguard_peers.create(
    wireguard_interface_id="6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(wireguard_peer.data)
返回参数：
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}
python
wireguard_peer = client.wireguard_peers.retrieve(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(wireguard_peer.data)
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}
python
wireguard_peer = client.wireguard_peers.retrieve(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(wireguard_peer.data)
返回参数：
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)
python
wireguard_peer = client.wireguard_peers.update(
    id="6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(wireguard_peer.data)
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
(字符串)
python
wireguard_peer = client.wireguard_peers.update(
    id="6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(wireguard_peer.data)
返回参数：
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}
python
wireguard_peer = client.wireguard_peers.delete(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(wireguard_peer.data)
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}
python
wireguard_peer = client.wireguard_peers.delete(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(wireguard_peer.data)
返回参数：
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
python
response = client.wireguard_peers.retrieve_config(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(response)
GET /wireguard_peers/{id}/config
python
response = client.wireguard_peers.retrieve_config(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(response)
",