ARNPROXY

पहुँच कार्रवाई जाँचें

GET/account/api/v1/proxies/access/status

प्राधिकरण

AuthorizationBearer YOUR_ARNPROXY_API_KEY
आवश्यक अनुमतिproxy_management
Acceptapplication/json
Idempotency-Key16–100 अक्षर, अंक, _ या -। एक ही कार्रवाई के लिए मान सहेजकर दोबारा उपयोग करें।

पैरामीटर

नामप्रकारविवरण
Idempotency-Key
headerआवश्यक
string16–100 अक्षर/अंक/_/-। कार्रवाई और स्थिति में समान मान रखें; अलग बॉडी में पुनः उपयोग न करें।

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

cURL
printf 'Authorization: Bearer %s\n' "$ARNPROXY_API_KEY" |
  curl --silent --show-error --header @- \
    --header 'Accept: application/json' \
    --connect-timeout 10 --max-time 30 \
    --header 'Idempotency-Key: YOUR_SAVED_OPERATION_KEY' \
    'https://www.arnproxy.com/account/api/v1/proxies/access/status'

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

उत्तर

200सफल उत्तर
application/json
{
    "ok": true,
    "data": {
        "state": "completed",
        "action": "ip_add",
        "proxy_ids": [
            12345
        ],
        "reason_code": null,
        "replayed": true,
        "provider_write_steps_sent": 1,
        "resume_available": false,
        "primary_credentials_locked": true,
        "credentials_returned": false,
        "balance_changed": false,
        "proxy_expiry_changed": false,
        "authorization_scope": "upstream_order",
        "shared_order_effects_accepted": true,
        "grant_state": "active"
    },
    "meta": {
        "request_id": "000000000000000000000001",
        "phase": "public_v1",
        "source": "arnproxy_records"
    }
}
उत्तर के फ़ील्ड और प्रकार
नामप्रकारविवरण
okbooleanसफलता संकेत; false पर error.code देखें।
dataobjectकार्रवाई-विशिष्ट परिणाम; उदाहरण कृत्रिम और समझाने के लिए हैं।
data.statestringरिकॉर्ड/कार्रवाई स्थिति। accepted डिलीवरी नहीं; completed कनेक्शन परीक्षण नहीं।
data.actionstringaction का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
data.proxy_idsarrayइस खाते को दिखने वाले दायरे की प्रॉक्सी ID।
data.proxy_ids[]integerइस खाते को दिखने वाले दायरे की प्रॉक्सी ID।
data.reason_codestring|nullनिश्चित कारण कोड या null, मूल प्रदाता त्रुटि पाठ नहीं।
data.replayedbooleanउसी कार्रवाई का सहेजा परिणाम लौटा, नए शुल्क/कार्रवाई का प्रमाण नहीं।
data.provider_write_steps_sentintegerprovider write steps sent का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
data.resume_availablebooleanन भेजे चरण को स्पष्ट रूप से जारी रखने की सुविधा; false पर स्वतः न दोहराएँ।
data.primary_credentials_lockedbooleanprimary credentials locked का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
data.credentials_returnedbooleancredentials returned का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
data.balance_changedbooleanकार्रवाई का बताया प्रभाव; स्वचालित नवीनीकरण बाद में अलग शुल्क लगा सकता है।
data.proxy_expiry_changedbooleanकार्रवाई का बताया प्रभाव; स्वचालित नवीनीकरण बाद में अलग शुल्क लगा सकता है।
data.authorization_scopestringप्राधिकरण दायरा। ऑर्डर/पैकेज की कार्रवाई अन्य आवंटन प्रभावित कर सकती है।
data.shared_order_effects_acceptedbooleanshared order effects accepted का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
data.grant_statestringIP अनुमति की स्थिति। हटाने की अपनी grant_state none हो सकती है; मूल अनुमति अलग रद्द होती है।
metaobjectअनुरोध संबद्धता और डेटा-स्रोत मेटाडेटा।
meta.request_idstringइस HTTP अनुरोध की पहचान; कार्रवाई कुंजी या ऑर्डर ID नहीं।
meta.phasestringphase का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
meta.sourcestringडेटा स्रोत; स्थानीय रिकॉर्ड और लाइव प्रदाता क्वेरी अलग प्रमाण हैं।

त्रुटि उत्तर

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

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

वर्तमान भाषा में खोजें। बंद करें: Esc