پرش به مطلب اصلی

SDK زبان Python

بسته arianet کلاینت رسمی Python برای وب سرویس‌های آریانت است. وابستگی خارجی ندارد (فقط کتابخانه استاندارد) و به Python نسخه ۳.۱۰ یا بالاتر نیاز دارد.

نصب​

pip install arianet

تا زمان انتشار بسته در PyPI، می‌توانید آن را مستقیم از GitHub نصب کنید:

pip install "git+https://github.com/ariaservice/arianet-python@v0.1.0"

شروع سریع​

در پنل یک توکن شخصی API بسازید و آن را export کنید:

export ARIANET_TOKEN="paste-your-token-here"
import arianet

client = arianet.Client() # reads ARIANET_TOKEN

page = client.cloud.list_servers(per_page=50)
for server in page["data"]:
print(server["id"], server["name"], server["status"])

گروه‌های API​

ویژگیوب سرویس
client.coreحساب، توکن‌ها، VPS، کلیدهای SSH، فایروال‌ها، موجودی و فاکتورها
client.cloudابر آریانت
client.regional_vpsVPS منطقه‌ای
client.hostingهاستینگ
client.baremetalسرور اختصاصی
client.smsپیامک

نام متدها شکل snake_case همان operationId است (listServers ← list_servers). پارامترهای مسیر آرگومان‌های اول هستند، بدنه JSON در آرگومان body (dict یا list) و پارامترهای query به صورت keyword داده می‌شوند (پارامتری که هم‌نام کلمه رزرو Python است، مثل from، با زیرخط پایانی نوشته می‌شود: from_). هر متد پاسخ JSON را decode شده برمی‌گرداند.

server = client.cloud.create_server({
"name": "web-1",
"plan_id": 101,
"image": "ubuntu-24.04",
"datacenter": "ovh",
})

تنظیمات​

client = arianet.Client(
"token", # default: ARIANET_TOKEN
base_url="https://api.ariaservice.net", # default, or ARIANET_API_URL
timeout=60.0,
max_retries=3,
max_retry_wait=60.0,
)

max_retries تعداد تکرار و max_retry_wait بیشترین زمان انتظار (ثانیه) پیش از هر تکرار است. اگر Retry-After بیشتر از این مقدار باشد، arianet.RateLimitError بلافاصله رخ می‌دهد و مقدار retry_after را دارد. برای اینکه تکرار سفارش حتی بعد از ری‌استارت برنامه هم امن باشد، idempotency_key="..." را خودتان بفرستید.

مدیریت خطا​

from arianet import ErrorCode

try:
client.core.create_server(order)
except arianet.APIError as err:
if err.code == ErrorCode.INSUFFICIENT_BALANCE:
... # top up the wallet
else:
print(err.status_code, err.code, err.message)
except arianet.APIConnectionError:
... # no answer: DNS, TLS, timeout

هر وضعیت HTTP کلاس خطای خودش را دارد: AuthenticationError (۴۰۱)، PaymentRequiredError (۴۰۲)، PermissionDeniedError (۴۰۳)، NotFoundError (۴۰۴)، ConflictError (۴۰۹)، UnprocessableEntityError (۴۲۲)، RateLimitError (۴۲۹) و InternalServerError (۵xx)؛ همه از APIError ارث می‌برند. err.reason در بعضی خطاها جزئیات بیشتری می‌دهد (مثلاً identity_hold).

ریجن و endpointهای جدید​

iran = client.regional_vps.with_region("iran-1")
servers = iran.list_servers()

# Any path, with the same auth, retries and errors:
client.request("GET", "/cloud/v1/new-endpoint", query={"page": 2})