API

💡 Python डेवलपर्स: आधिकारिक का उपयोग करें clore-ai Python SDK कच्चे API कॉल्स के बजाय। यह ऑटोमेटिक रूप से प्रमाणीकरण, रेट लिमिटिंग, retries और त्रुटि हैंडलिंग संभालता है।

त्वरित प्रारंभ: pip install clore-ai — देखें Python SDK दस्तावेज और CLI संदर्भ.

परिचय

CLORE.AIarrow-up-right API का उपयोग आपके वर्कलोड्स को ऑटोमेट करने के लिए किया जा सकता है onto CLORE.AIarrow-up-right

पहले आपको एक API कुंजी प्राप्त करनी होगी alt text alt text


API उत्तर

प्रत्युत्तर JSON प्रारूप में लौटाए जाते हैं, जिनमें विभिन्न फ़ील्ड हो सकते हैं

हमेशा लौटाया जाने वाला फ़ील्ड code है, जो स्थिति दर्शाता है

code फ़ील्ड

code
विवरण

0

सामान्य

1

डेटाबेस त्रुटि

2

अमान्य इनपुट डेटा

3

अमान्य API टोकन

4

अमान्य एंडपॉइंट

5

1 अनुरोध/सेकंड सीमा से अधिक

6

त्रुटि निर्दिष्ट की गई में error फ़ील्ड


एंडपॉइंट्स

1. wallets

के बारे में

वॉलेट्स और बैलेंस लौटाएं

हेडर

फ़ील्ड
प्रकार
अनिवार्य
विवरण

auth

स्ट्रिंग

हाँ

API टोकन

आउटपुट

फ़ील्ड
प्रकार
विवरण

code

int

स्थिति कोड

wallets

[]string

वॉलेट्स की सरणी

उदाहरण

इनपुट:

आउटपुट:

2. my_servers

के बारे में

वे आपके सर्वर लौटाता है जिन्हें आप प्रदान कर रहे हैं to clore.aiarrow-up-right मार्केटप्लेस

हेडर

फ़ील्ड
प्रकार
अनिवार्य
विवरण

auth

स्ट्रिंग

हाँ

API टोकन

आउटपुट

फ़ील्ड
प्रकार
विवरण

code

int

स्थिति कोड

सीमा

int

अधिकतम सर्वरों की संख्या जो आप मालिक हो सकते हैं

servers

[]string

सर्वरों की सरणी

servers[x].name

स्ट्रिंग

उपयोगकर्ता द्वारा चुना गया सर्वर नाम

servers[x].connected

स्ट्रिंग

क्या सर्वर कभी जुड़ा हुआ था to clore.aiarrow-up-right

servers[x].visibility

स्ट्रिंग

मार्केटप्लेस पर दृश्यता

servers[x].pricing

[]string

मांग पर कीमत/दिन

servers[x].online

बूल

क्या सर्वर ऑनलाइन है

servers[x].min_spot_pricing

[]string

स्पॉट मार्केट के लिए न्यूनतम किराया/दिन

servers[x].init_token

स्ट्रिंग

प्रारंभिककरण टोकन

servers[x].specs

[]string

सर्वर विनिर्देश

उदाहरण

इनपुट:

आउटपुट:

*USD अभी लागू नहीं हुआ

3. server_config

के बारे में

विशिष्ट सर्वर का कॉन्फ़िगरेशन प्राप्त करें

हेडर

फ़ील्ड
प्रकार
अनिवार्य
विवरण

auth

स्ट्रिंग

हाँ

API टोकन

Content-type

स्ट्रिंग

हाँ

होना चाहिए application/json

बॉडी

फ़ील्ड
प्रकार
अनिवार्य
विवरण

server_name

स्ट्रिंग

हाँ

सर्वर नाम

आउटपुट

फ़ील्ड
प्रकार
विवरण

code

int

स्थिति कोड

creation_completed

बूल

क्या सर्वर निर्माण पूरा है

config

[]string

सर्वर का कॉन्फ़िग

config.name

स्ट्रिंग

उपयोगकर्ता द्वारा चुना गया सर्वर नाम

config.connected

बूल

क्या सर्वर कभी जुड़ा हुआ था to clore.aiarrow-up-right

config.visibility

स्ट्रिंग

मार्केटप्लेस पर दृश्यता

config.pricing

[]string

मांग पर कीमत/दिन

config.spot_pricing

[]string

स्पॉट मार्केट के लिए न्यूनतम किराया/दिन

config.mrl

int

अधिकतम किराये की अवधि घंटों में

config.online

बूल

क्या सर्वर ऑनलाइन है

config.initialized

बूल

क्या सर्वर कभी जुड़ा हुआ था to clore.aiarrow-up-right

config.id

int

अद्वितीय सर्वर ID

config.rental_status

int

0 - किराए पर नहीं | 1 - स्पॉट मार्केट पर किराए पर | 2 - ऑन डिमांड पर किराए पर

config.specs

[]string

सर्वर विनिर्देश

config.background_job

[]string

नॉन-रेंटेड होने पर बैकग्राउंड जॉब

उदाहरण

इनपुट:

आउटपुट:

*USD अभी लागू नहीं हुआ

4. मार्केटप्लेस

के बारे में

मार्केटप्लेस प्राप्त करें

हेडर

फ़ील्ड
प्रकार
अनिवार्य
विवरण

auth

स्ट्रिंग

हाँ

API टोकन

आउटपुट

फ़ील्ड
प्रकार
विवरण

code

int

स्थिति कोड

my_servers

[]string

सर्वरों की उस सरणी की आईडी जिन्हें आप प्रदान कर रहे हैं clore.aiarrow-up-right (किराए पर नहीं लिया जा सकता)

servers

[]string

मार्केटप्लेस पर सार्वजनिक सर्वरों की सरणी

servers[x].id

int

अद्वितीय सर्वर ID

servers[x].owner

int

अद्वितीय मालिक ID

servers[x].mrl

int

अधिकतम किराये की अवधि घंटों में

servers[x].price.on_demand

[]string

मांग पर कीमत प्रति दिन

servers[x].spot

[]string

स्पॉट मार्केट के लिए न्यूनतम कीमत प्रति दिन

servers[x].rented

बूल

क्या सर्वर मांग पर किराए पर है

servers[x].specs

[]string

सर्वर विनिर्देश

उदाहरण

मार्केटप्लेस प्राप्त करें

इनपुट:

आउटपुट:

5. my_orders

के बारे में

अपने ऑर्डर प्राप्त करें

हेडर

फ़ील्ड
प्रकार
अनिवार्य
विवरण

auth

स्ट्रिंग

हाँ

API टोकन

क्वेरी स्ट्रिंग

फ़ील्ड
प्रकार
अनिवार्य
विवरण

return_completed

बूल

नहीं

पूर्ण (समाप्त) ऑर्डर लौटाएं

आउटपुट

फ़ील्ड
प्रकार
विवरण

code

int

स्थिति कोड

सीमा

int

सक्रिय ऑर्डरों की अधिकतम संख्या

orders

[]string

ऑर्डरों की सरणी

orders[x].id

int

अद्वितीय ऑर्डर ID

orders[x].fee

फ्लोट

फीस (%) जो भुगतान की जाती है to clore.aiarrow-up-right

orders[x].creation_fee

फ्लोट

निर्माण शुल्क जो भुगतान किया गया clore.aiarrow-up-right

orders[x].price

फ्लोट

ऑर्डर कीमत (लागत) प्रति दिन

orders[x].mrl

int

ऑर्डर की अधिकतम किराये की अवधि सेकंड में

orders[x].image

स्ट्रिंग

प्रयोजित डॉकर इमेज

orders[x].currency

स्ट्रिंग

बिलिंग के लिए प्रयुक्त मुद्रा

orders[x].spend

फ्लोट

ऑर्डर पर खर्च की गई राशि

orders[x].ct

int

निर्माण समय (UNIX समय)

orders[x].p

int

वर्तमान में प्रयुक्त प्रॉक्सी क्लस्टर

orders[x].specs

[]string

सर्वर विनिर्देश

orders[x].si

int

अद्वितीय सर्वर ID

orders[x].pub_cluster

[]string

फॉरवर्ड किए गए पोर्ट्स के साथ सार्वजनिक एंडपॉइंट्स

orders[x].tcp_ports

[]string

TCP पोर्ट फॉरवर्डिंग

orders[x].http_port

स्ट्रिंग

HTTPS प्रॉक्सी के माध्यम से फॉरवर्ड किया गया कंटेनर पोर्ट

orders[x].spot

बूल

इस बात का संकेत कि यह स्पॉट ऑर्डर है

orders[x].expired

बूल

इस बात का संकेत कि ऑर्डर समाप्त हो चुका है

इनपुट:

आउटपुट:

6. spot_marketplace

के बारे में

विशिष्ट सर्वर के लिए स्पॉट मार्केटप्लेस प्राप्त करें

हेडर

फ़ील्ड
प्रकार
अनिवार्य
विवरण

auth

स्ट्रिंग

हाँ

API टोकन

क्वेरी स्ट्रिंग

फ़ील्ड
प्रकार
अनिवार्य
विवरण

market

int

हाँ

अद्वितीय सर्वर ID

आउटपुट

फ़ील्ड
प्रकार
विवरण

code

int

स्थिति कोड

मौजूद है

बूल

सत्यापन कि मार्केट मौजूद है

market

ऑब्जेक्ट

मार्केटप्लेस

market.offers

सरणी

सर्वर के लिए किराये के ऑफ़र

market.offers[x].offer_id

int

अद्वितीय ऑफ़र ID

market.offers[x].bid

फ्लोट

प्रस्तावित कीमत प्रति दिन

market.offers[x].active

बूल

यह ऑफ़र वर्तमान में उपयोग किया जा रहा है

market.offers[x].my

बूल

यह ऑफ़र मेरा है

market.server

ऑब्जेक्ट

सर्वर जानकारी

market.server.min_pricing

ऑब्जेक्ट

न्यूनतम ऑफ़र कीमत प्रति दिन

market.server.mrl

int

अधिकतम किराये की अवधि सेकंड में

market.server.visibility

स्ट्रिंग

आप केवल तब ऑफ़र बना सकते हैं जब दृश्यता public हो

market.server.online

बूल

सर्वर ऑनलाइन है

इनपुट:

आउटपुट:

7. set_server_settings

के बारे में

उन सर्वरों के सेटिंग्स कॉन्फ़िगर करें जिन्हें आप प्रदान कर रहे हैं on clore.aiarrow-up-right मार्केटप्लेस

हेडर

फ़ील्ड
प्रकार
अनिवार्य
विवरण

auth

स्ट्रिंग

हाँ

API टोकन

Content-type

स्ट्रिंग

हाँ

होना चाहिए application/json

बॉडी

फ़ील्ड
प्रकार
अनिवार्य
विवरण

name

स्ट्रिंग

हाँ

उपयोगकर्ता द्वारा चुना गया सर्वर नाम

उपलब्धता

बूल

हाँ

क्या सर्वर किराए पर दिया जा सकता है

mrl

int

हाँ

सर्वर की अधिकतम किराये की अवधि

on_demand

फ्लोट

हाँ

आपके सर्वर के लिए ऑन-डिमांड कीमत प्रति दिन

spot

फ्लोट

हाँ

SPOT ऑफ़र के लिए न्यूनतम कीमत प्रति दिन

आउटपुट

फ़ील्ड
प्रकार
विवरण

code

int

स्थिति कोड

उदाहरण

आइए वर्तमान वॉलेट से भेजे गए लेनदेन के लिए एक सेंड प्रूफ बनाएं।

इनपुट:

आउटपुट:

8. set_spot_price

के बारे में

अपने SPOT मार्केट ऑफ़र पर प्रति दिन कीमत सेट करें

हेडर

फ़ील्ड
प्रकार
अनिवार्य
विवरण

auth

स्ट्रिंग

हाँ

API टोकन

Content-type

स्ट्रिंग

हाँ

होना चाहिए application/json

बॉडी

फ़ील्ड
प्रकार
अनिवार्य
विवरण

order_id

int

हाँ

अद्वितीय ऑफ़र ID

इच्छित_कीमत

फ्लोट

हाँ

आपकी प्रतिदिन पेश की गई कीमत

उदाहरण

आइए स्पॉट मार्केट कीमत को अपडेट करने का प्रयास करें

इनपुट 1 (कदम कम बहुत बड़ा था):

संभव आउटपुट 1 (कदम कम बहुत बड़ा था): आप स्पॉट मार्केट ऑफ़र की कीमत अधिकतम 0.00000100 ₿ तक ही घटा सकते हैं

फ़ील्ड
प्रकार
विवरण

code

int

स्थिति कोड

error

स्ट्रिंग

त्रुटि विवरण फ़ील्ड

max_step

फ्लोट

सबसे कम संभव मान जिसकी ओर आप वर्तमान में कीमत घटा सकते हैं

इनपुट 2 (मान्य कीमत कदम घटाना):

संभव आउटपुट 2 (मान्य कीमत कदम घटाना):

इनपुट 3 (इनपुट 2 भेजने के बाद और भी कम कीमत):

संभव आउटपुट 3 (इनपुट 2 भेजने के बाद और भी कम कीमत): आप स्पॉट कीमत हर 600 सेकंड में एक बार ही घटा सकते हैं

फ़ील्ड
प्रकार
विवरण

code

int

स्थिति कोड

error

स्ट्रिंग

त्रुटि विवरण फ़ील्ड

time_to_lowering

फ्लोट

अगली बार कीमत घटाने की संभाव्यता तक शेष समय (सेकंड)

9. cancel_order

के बारे में

अपने SPOT मार्केट ऑफ़र पर प्रति दिन कीमत सेट करें

हेडर

फ़ील्ड
प्रकार
अनिवार्य
विवरण

auth

स्ट्रिंग

हाँ

API टोकन

Content-type

स्ट्रिंग

हाँ

होना चाहिए application/json

बॉडी

फ़ील्ड
प्रकार
अनिवार्य
विवरण

id

int

हाँ

अद्वितीय ऑर्डर/ऑफ़र ID

issue

स्ट्रिंग

नहीं

यदि आपको सर्वर के साथ कोई समस्या आई है तो आप उन्हें टीम को रिपोर्ट कर सकते हैं, अधिकतम 2048 वर्ण clore.aiarrow-up-right टीम, अधिकतम 2048 वर्ण

आउटपुट

फ़ील्ड
प्रकार
विवरण

code

int

स्थिति कोड

उदाहरण

ऑर्डर/ऑफ़र रद्द करें

इनपुट: इस उदाहरण में हम GPU #1 के साथ समस्याएँ रिपोर्ट कर रहे हैं, यदि आपकी कोई समस्या नहीं है तो issue फ़ील्ड शामिल न करें। आप टेक्स्ट फ़ील्ड में कोई भी संदेश लिख सकते हैं और हम इसकी जाँच करेंगे

आउटपुट:

10. create_order

के बारे में

आप इस एंडपॉइंट से स्पॉट ऑफ़र या ऑन-डिमांड ऑर्डर बना सकते हैं यह एंडपॉइंट भी केवल 5 सेकंड में 1 अनुरोध की अनुमति देता है

हेडर

फ़ील्ड
प्रकार
अनिवार्य
विवरण

auth

स्ट्रिंग

हाँ

API टोकन

Content-type

स्ट्रिंग

हाँ

होना चाहिए application/json

बॉडी

फ़ील्ड
प्रकार
अनिवार्य
विवरण

मुद्रा

स्ट्रिंग

हाँ

मुद्रा का नाम

image

स्ट्रिंग

हाँ

dockerhub से मान्य इमेज

renting_server

int

हाँ

उस सर्वर की ID जिसे आप किराए पर लेना चाहते हैं

प्रकार

स्ट्रिंग

हाँ

on-demand या spot

spotprice

फ्लोट

निर्भर करता है

स्पॉट मार्केट पर प्रति दिन पेश की गई कीमत, स्पॉट ऑर्डर बनाते समय आवश्यक

ports

ऑब्जेक्ट

नहीं

पोर्ट फॉरवर्डिंग कॉन्फ़िगरेशन, अधिकतम 5 रिकॉर्ड

env

ऑब्जेक्ट

नहीं

पर्यावरण चर, स्ट्रिंग में बदलने पर कुल मिलाकर 12000 अक्षरों तक सीमित। वैरिएबल नाम - अधिकतम 128 अक्षर वैरिएबल मान - अधिकतम 1536 अक्षर

jupyter_token

स्ट्रिंग

नहीं

जुपिटर टोकन उन इमेज के लिए जिनमें जुपिटर नोटबुक हैं, अधिकतम 32 अक्षर *

ssh_key

स्ट्रिंग

नहीं

SSH की उन इमेज के लिए जिनमें SSH है, अधिकतम 3072 अक्षर *

ssh_password

स्ट्रिंग

नहीं

SSH पासवर्ड उन इमेज के लिए जिनमें SSH है, अधिकतम 32 अक्षर *

command

स्ट्रिंग

नहीं

ऑर्डर बनाने के बाद सर्वर पर कमांड चलाया जाएगा

required_price

फ्लोट

नहीं

उस कीमत का निर्दिष्ट करें जिस पर आप ऑर्डर शुरू करना चाहते हैं, यदि मशीन मालिक कीमत बदलता है, तो ऑर्डर शुरू नहीं होगा (सिर्फ ऑन-डिमांड)

autossh_entrypoint

बूल

नहीं

clore.ai एंट्रीपॉइंट का उपयोग करें, जो स्वचालित रूप से SSH सर्वर और कस्टम तैनात करता है /root/onstart.sh स्क्रिप्ट

* जिन फ़ील्ड्स पर तारिका(*) चिह्न है उनमें आप केवल इस regexp समूह के वर्ण ही इनपुट कर सकते हैं /^[a-zA-Z0-9\s-=.@+/]+$/

आउटपुट

फ़ील्ड
प्रकार
विवरण

code

int

स्थिति कोड

उदाहरण

इनपुट 1 (स्पॉट ऑफ़र बनाएं):

आउटपुट 1 (स्पॉट ऑफ़र बनाएं):

इनपुट 2 (माँग पर ऑर्डर बनाएं):

आउटपुट 2 (माँग पर ऑर्डर बनाएं):

Last updated

Was this helpful?