प्रॉक्सी नोट सहेजें

POST/account/api/v1/proxies/note

प्राधिकरण

Authorization	`Bearer YOUR_ARNPROXY_API_KEY`
आवश्यक अनुमति	`proxy_management`
Accept	`application/json`
Content-Type	`application/json`

पैरामीटर

नाम	प्रकार	विवरण
`proxy_id` bodyआवश्यक	`integer`	अपने सक्रिय प्रॉक्सी रिकॉर्ड की ID; 1–2147483647।
`note` bodyआवश्यक	`string`	काट-छाँट के बाद अधिकतम 500 अक्षर और पढ़ने के उत्तर की संग्रह सीमा। खाली पाठ नोट हटाता है।
`expected_revision` bodyआवश्यक	`string`	इस कार्रवाई की दायरा/सेटिंग क्वेरी का revision: 64 छोटे हेक्स अक्षर।

अनुरोध का मुख्य भाग

YOUR_/FROM_ को संबंधित कैटलॉग, कोट या दायरे के मान से बदलें। उदाहरणों में सहमति false है; वास्तविक कार्रवाई केवल जानबूझकर मंज़ूर करें।

request.json

{
    "proxy_id": "YOUR_PROXY_ID",
    "note": "My application",
    "expected_revision": "FROM_PROXY_NOTE_REVISION"
}

अनुरोध उदाहरण

cURL

printf 'Authorization: Bearer %s\n' "$ARNPROXY_API_KEY" |
  curl --silent --show-error --header @- \
    --header 'Accept: application/json' \
    --connect-timeout 10 --max-time 30 \
    --request POST --header 'Content-Type: application/json' \
    --data-binary @request.json \
    'https://www.arnproxy.com/account/api/v1/proxies/note'

इस पेज पर उदाहरण नहीं चलते। API कुंजी सर्वर की पर्यावरण चर में रखें, URL या ब्राउज़र कोड में नहीं। POST के लिए request.json तैयार करें।

उत्तर

200सफल उत्तर

application/json

{
    "ok": true,
    "data": {
        "state": "completed",
        "changed": true,
        "provider_requests": 0,
        "proxy_id": 12345,
        "note": "Example label",
        "revision": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "note_update_available": true,
        "clear_with_empty_string": true,
        "source": "arnproxy_records",
        "maximum_length": 500,
        "maximum_utf8_bytes": 2000,
        "full_unicode_supported": true
    },
    "meta": {
        "request_id": "000000000000000000000001",
        "phase": "public_v1",
        "source": "arnproxy_records"
    }
}

उत्तर के फ़ील्ड और प्रकार

नाम	प्रकार	विवरण
`ok`	`boolean`	सफलता संकेत; false पर error.code देखें।
`data`	`object`	कार्रवाई-विशिष्ट परिणाम; उदाहरण कृत्रिम और समझाने के लिए हैं।
`data.state`	`string`	रिकॉर्ड/कार्रवाई स्थिति। accepted डिलीवरी नहीं; completed कनेक्शन परीक्षण नहीं।
`data.changed`	`boolean`	क्या नोट वास्तव में बदला; false का अर्थ वही पाठ पहले से होना भी है।
`data.provider_requests`	`integer`	provider requests का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
`data.proxy_id`	`integer`	संबंधित ARNPROXY रिकॉर्ड ID; आंतरिक प्रदाता ID के बदले इसे लें।
`data.note`	`string`	note का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
`data.revision`	`string`	संबंधित बदलाव/मूल्य पुष्टि में अपरिवर्तित लौटाने वाला ताज़गी संकेत।
`data.note_update_available`	`boolean`	note update available का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
`data.clear_with_empty_string`	`boolean`	clear with empty string का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
`data.source`	`string`	डेटा स्रोत; स्थानीय रिकॉर्ड और लाइव प्रदाता क्वेरी अलग प्रमाण हैं।
`data.maximum_length`	`integer`	maximum length का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
`data.maximum_utf8_bytes`	`integer`	maximum utf8 bytes का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
`data.full_unicode_supported`	`boolean`	full unicode supported का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
`meta`	`object`	अनुरोध संबद्धता और डेटा-स्रोत मेटाडेटा।
`meta.request_id`	`string`	इस HTTP अनुरोध की पहचान; कार्रवाई कुंजी या ऑर्डर ID नहीं।
`meta.phase`	`string`	phase का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
`meta.source`	`string`	डेटा स्रोत; स्थानीय रिकॉर्ड और लाइव प्रदाता क्वेरी अलग प्रमाण हैं।

त्रुटि उत्तर

HTTP 401 · INVALID_API_KEY

{
  "ok": false,
  "error": { "code": "INVALID_API_KEY" },
  "meta": { "request_id": "000000000000000000000001" }
}

प्रमाणीकरण और जाँच निष्पादन से पहले अनुरोध रोक सकते हैं। त्रुटि संदर्भ देखें और सहायता के लिए request_id रखें। कुंजी या पासवर्ड न भेजें। त्रुटियाँ और सीमाएँ →

व्यवहार और महत्वपूर्ण नोट

मौजूदा ग्राहक-पैनल प्रॉक्सी नोट उपयोग होता है, प्रदाता को कुछ नहीं भेजता। GET संग्रह सीमा में अधिकतम 500 अक्षर। note="" साफ़ करता है। पहले proxy_note से revision लें। समान पाठ changed:false; पुराने revision से अलग पाठ नहीं बदलता। Idempotency-Key नहीं चाहिए; अनिश्चित उत्तर पर फिर पढ़ें।