विन्यास एपीआई - addSocketSite

Prev Next

हम दृढ़ता से अनुशंसा करते हैं कि Cato API का उपयोग शुरू करने से पहले, कृपया Cato API के लिए सहायता नीति की समीक्षा करें।

addSocketSite का अवलोकन

अपने खाते में एक नया सॉकेट साइट बनाने और साइट के लिए निम्नलिखित सेटिंग्स को परिभाषित करने के लिए addSocketSite म्यूटेशन एपीआई का उपयोग करें:

  • नाम

  • विवरण

  • प्रकार

  • कनेक्शन प्रकार

  • समय क्षेत्र

  • देश

  • राज्य

  • पता

  • देशज श्रेणी

यह साइट डिफ़ॉल्ट बैंडविड्थ सेटिंग्स, 25 एमबीपीएस डाउनस्ट्रीम और 25 एमबीपीएस अपस्ट्रीम के साथ बनाई गई है, और इसके लिए लाइसेंस असाइन नहीं किया गया है।

पुनर्विक्रेता खातों के लिए, आप उस ग्राहक खाते के अंदर अलग एपीआई कुंजी बना सकते हैं जिसे आप Cato API के साथ सेटिंग्स को कॉन्फ़िगर कर रहे हैं।

खाते के लिए खाता आईडी का पता लगाना

यह खाता आईडीCato प्रबंधन अनुप्रयोग में नहीं दिखाया जाता है, बल्कि यह Cato प्रबंधन अनुप्रयोग के लिए यूआरएल में संख्या है। उदाहरण के लिए, निम्नलिखित  यूआरएल के लिए खाता आईडी 26 है: https://cc.catonetworks.com/#!/26/topology।

इस आईडी को साइट निर्माण एपीआई के लिए accountId तर्क में दर्ज करें, उदाहरण के लिए:

site(accountId: 26) {
    addSocketSite(input: $addSocketSite) { 
        siteId 
    } 
}

addSocketSite तर्कों के लिए विवरण

ये Cato विन्यास एपीआई का उपयोग करके नया सॉकेट साइट बनाने के लिए तर्क हैं। तर्क अनिवार्य हैं जब तक कि वैकल्पिक के रूप में चिह्नित न हो:

  • नाम - साइट का नाम

  • connectionType - इस साइट के लिए भौतिक सॉकेट या vSocket

  • साइट प्रकार - आपकी संस्था में साइट का प्रकार, उदाहरण के लिए क्लाउड डेटा सेंटर

  • विवरण - (वैकल्पिक) साइट का विवरण

  • nativeNetworkRange - साइट के पीछे देशज लैन के लिए आईपी श्रेणी, CIDR प्रारूप में

  • साइट स्थान - साइट के भौतिक स्थान के बारे में डेटा

AddSocketSite नाम

आप जिस सॉकेट साइट बना रहे हैं उसका नाम परिभाषित करें।

AddSocketSite connectionType

connectionType एक इनम तर्क है जो साइट के लिए भौतिक या वर्चुअल सॉकेट के प्रकार को परिभाषित करता है।

ये विकल्प हैं:

  • SOCKET_X1500 - X1500 या X1500B सॉकेट भौतिक साइट के लिए

  • SOCKET_X1600 - X1600 सॉकेट भौतिक साइट के लिए

  • SOCKET_X1700 - X1700 या X1700B सॉकेट भौतिक साइट के लिए

  • SOCKET_ESX - वर्चुअल VMware साइट के लिए vSocket

  • SOCKET_AWS - वर्चुअल AWS साइट के लिए vSocket

  • SOCKET_AZURE - वर्चुअल Azure साइट के लिए vSocket

AddSocketSite siteType

siteType एक enum तर्क है जो साइट के प्रकार को परिभाषित करता है जो निर्धारित करता है कि Cato प्रबंधन एप्लिकेशन में मॉनिटरिंग > टोपोलॉजी स्क्रीन में कौन सा आइकन उपयोग किया जाता है।

ये विकल्प हैं:

  • शाखा - भौतिक या वर्चुअल साइट्स

  • मुख्यालय - कॉर्पोरेट मुख्यालय के लिए भौतिक साइट्स

  • क्लाउड_DC - क्लाउड आधारित डाटासेंटर्स के लिए वर्चुअल साइट्स

  • डाटासेंटर - डाटासेंटर्स के लिए भौतिक साइट

AddSocketSite विवरण (वैकल्पिक)

विवरण साइट का वर्णन करने के लिए एक वैकल्पिक मुक्त-पाठ फ़ील्ड है।

AddSocketSite nativeNetworkRange

nativeNetworkRange तर्क में साइट के लिए लैन देशज श्रेणी के लिए आईपी श्रेणी को परिभाषित करें। देशज श्रेणी उपनेट के लिए CIDR का उपयोग करती है, और /32 CIDR ब्लॉक्स समर्थित नहीं हैं।

AddSocketSite siteLocation

siteLocation तर्क साइट के लिए निम्नलिखित भौतिक विवरणों को परिभाषित करते हैं। countryCode आपके खाते के एक विशिष्ट क्षेत्र के लिए उपलब्ध साइट लाइसेंसों की संख्या के लिए प्रासंगिक है।

आप इन तर्कों के लिए मान प्राप्त करने के लिए entityLookup एपीआई क्वेरी का उपयोग कर सकते हैं, देखें Cato एपीआई - EntityLookup।

ये siteLocation तर्क हैं:

  • countryCode - दो अक्षरीय कोड (ISO 3166-1 alpha-2) उस देश के लिए जहां साइट स्थित है

    entityLookup के लिए, type का उपयोग मूल्य के साथ देश करें

  • stateCode - (वैकल्पिक) लागू देशों के लिए, जहां साइट स्थित है वह राज्य

    entityLookup के लिए, type का उपयोग मूल्य के साथ देशराज्य करें

  • समय क्षेत्र - साइट के लिए समय क्षेत्र, सॉकेट और vSocket उन्नयन के लिए रखरखाव विंडो के लिए समय सीमा सेट करने के लिए उपयोग किया जाता है

    entityLookup के लिए, type का उपयोग मूल्य के साथ समय क्षेत्र करें

  • पता - (वैकल्पिक) भौतिक साइट के लिए गली का पता

उदाहरण पोस्टमैन स्क्रिप्ट

mutation addSocketSite ($accountId: ID!, $input: AddSocketSiteInput!) {
    site(accountId: $accountId) {
        addSocketSite (input: $input) {
            siteId
        }
    }
}

ग्राफक्यूएल वेरिएबल्स

{
    "accountId": "26",
    "input": {
        "name": "SampleUsSite2",
        "description": "My first API site",
        "siteType": "BRANCH",
        "connectionType": "SOCKET_X1500",
        "nativeNetworkRange": "10.0.0.0/24",
        "siteLocation": {
            "countryCode": "US",
            "timezone": "US/Central",
            "stateCode": "US-AL"
        }
    }
}

संबंधित संसाधन