API

परिचय

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

त्रुटि निर्दिष्ट की गई है त्रुटि फ़ील्ड


एंडपॉइंट्स

1. वॉलेट्स

के बारे में

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

हैडर

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

auth

स्ट्रिंग

हाँ

API टोकन

आउटपुट

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

code

int

स्थिति कोड

वॉलेट्स

[]string

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

उदाहरण

इनपुट:

आउटपुट:

2. my_servers

के बारे में

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

हैडर

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

auth

स्ट्रिंग

हाँ

API टोकन

आउटपुट

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

code

int

स्थिति कोड

सीमा

int

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

सर्वर

[]string

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

servers[x].name

स्ट्रिंग

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

servers[x].connected

स्ट्रिंग

क्या सर्वर कभी कनेक्ट हुआ था 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

बूल

क्या सर्वर कभी कनेक्ट हुआ था clore.aiarrow-up-right

config.visibility

स्ट्रिंग

बाज़ार में दृश्यता

config.pricing

[]string

प्रति दिन ऑन-डिमांड कीमत

config.spot_pricing

[]string

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

config.mrl

int

घंटों में अधिकतम रेंटल अवधि

config.online

बूल

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

config.initialized

बूल

क्या सर्वर कभी कनेक्ट हुआ था clore.aiarrow-up-right

config.id

int

विशिष्ट सर्वर आईडी

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 (किराए पर नहीं दिए जा सकते)

सर्वर

[]string

बाज़ार पर सार्वजनिक सर्वरों की सरणी

servers[x].id

int

विशिष्ट सर्वर आईडी

servers[x].owner

int

विशिष्ट मालिक आईडी

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

विशिष्ट ऑर्डर आईडी

orders[x].fee

फ्लोट

शुल्क (%) जो दिया जाता है 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

विशिष्ट सर्वर आईडी

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 टोकन

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

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

बाज़ार

int

हाँ

विशिष्ट सर्वर आईडी

आउटपुट

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

code

int

स्थिति कोड

मौजूद है

बूल

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

बाज़ार

वस्तु

बाज़ार

market.offers

सरणी

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

market.offers[x].offer_id

int

विशिष्ट ऑफ़र आईडी

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

स्ट्रिंग

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

market.server.online

बूल

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

इनपुट:

आउटपुट:

7. set_server_settings

के बारे में

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

हैडर

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

auth

स्ट्रिंग

हाँ

API टोकन

Content-type

स्ट्रिंग

हाँ

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

बॉडी

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

नाम

स्ट्रिंग

हाँ

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

उपलब्धता

बूल

हाँ

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

mrl

int

हाँ

अधिकतम सर्वर रेंटल अवधि

on_demand

फ्लोट

हाँ

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

spot

फ्लोट

हाँ

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

आउटपुट

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

code

int

स्थिति कोड

उदाहरण

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

इनपुट:

आउटपुट:

8. set_spot_price

के बारे में

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

हैडर

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

auth

स्ट्रिंग

हाँ

API टोकन

Content-type

स्ट्रिंग

हाँ

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

बॉडी

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

order_id

int

हाँ

विशिष्ट ऑफ़र आईडी

desired_price

फ्लोट

हाँ

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

उदाहरण

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

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

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

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

code

int

स्थिति कोड

त्रुटि

स्ट्रिंग

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

max_step

फ्लोट

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

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

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

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

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

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

code

int

स्थिति कोड

त्रुटि

स्ट्रिंग

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

time_to_lowering

फ्लोट

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

9. cancel_order

के बारे में

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

हैडर

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

auth

स्ट्रिंग

हाँ

API टोकन

Content-type

स्ट्रिंग

हाँ

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

बॉडी

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

id

int

हाँ

विशिष्ट ऑर्डर/ऑफ़र आईडी

issue

स्ट्रिंग

नहीं

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

आउटपुट

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

code

int

स्थिति कोड

उदाहरण

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

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

आउटपुट:

10. create_order

के बारे में

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

हैडर

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

auth

स्ट्रिंग

हाँ

API टोकन

Content-type

स्ट्रिंग

हाँ

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

बॉडी

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

currency

स्ट्रिंग

हाँ

मुद्रा का नाम

image

स्ट्रिंग

हाँ

dockerhub से वैध इमेज

renting_server

int

हाँ

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

type

स्ट्रिंग

हाँ

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?