Зміна інформації проксі-сервера

Довідник API

Зміна інформації проксі-сервера

Request

Оновлює конфігурацію проксі.

Передумови: проксі має існувати в команді. Динамічні проксі через цей ендпоінт оновити неможливо. Провайдер має бути розпізнаваним значенням.
Ефект: це повне перезаписування, а не часткове оновлення: пропущені вами поля повертаються до значень за замовчуванням, а не зберігають поточні. Спершу прочитайте проксі й надішліть його назад цілком.
Область дії: прив'язки профілів зберігаються, бо змінюється лише сам запис проксі, але вже запущені браузер або хмарний телефон і далі використовують дані підключення, з якими вони були запущені. Перезапустіть їх, щоб застосувати нові.
Завершення: синхронне. Оптимістичного блокування немає, тому за одночасних оновлень перемагає останній запис.

Задокументовані бізнес-помилки: 14003, 14023. Значення кодів див. у Error Codes. Будь-яка операція може додатково повернути загальні коди.

Bodyapplication/jsonrequired

idstringrequired

Унікальний ідентифікатор проксі-сервера

proxyIpstringrequired

IP-адреса проксі-сервера

proxyPortintegerrequired

Порт проксі-сервера

proxyNamestring

Власне ім'я для проксі-сервера

countrystring

Країна (наприклад, «США», «КНР»)

citystring

Назва міста

usernamestring

Ім'я користувача для автентифікації (за потреби)

passwordstring

Пароль автентифікації (якщо потрібно)

proxyTypeinteger

Тип проксі-протоколу:

0 = HTTP
1 = HTTPS
2 = SOCKS5
3 = SSH

proxyProviderintegerrequired

Ідентифікатор проксі-провайдера:

0 = HTTP
1 = HTTPS
2 = SOCKS5
3 = SSH
4 = Oxylabs
5 = Proxys.io
6 = GeoSurf
7 = Luminati
8 = Lumauto
9 = Oxylabsauto
10 = Trojan
11 = Shadowsocks
12 = vmess
13 = ABCPROXY
14 = LunaProxy
15 = IPHTML
16 = PiaProxy
17 = 922S5

encryptionTypeinteger

Тип шифрування (залежно від постачальника, зазвичай 0 для звичайного)

ipMonitorboolean

Увімкнути моніторинг зміни IP-адреси

ipChangeActioninteger

Дія, яку потрібно виконати при зміні IP-адреси:

1 = Повідомити / Оновити (загальне значення)

Повні опції дивіться в документації до системи.

refreshUrlstring

URL-адреса для оновлення IP-адреси (якщо підтримується постачальником)

statestring

Зарезервоване поле або налаштований стан (необов'язково)

POST

/api/proxyInfo/update

curl -i -X POST \
  http://127.0.0.1:40000/api/proxyInfo/update \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "1566403036579198",
    "proxyIp": "108.11.23.85",
    "proxyPort": 4096,
    "proxyName": "MyProxy",
    "country": "US",
    "city": "New York",
    "username": "",
    "password": "",
    "proxyType": 0,
    "proxyProvider": 0,
    "encryptionType": 0,
    "ipMonitor": true,
    "ipChangeAction": 1,
    "refreshUrl": "",
    "state": ""
  }'

Responses

Успіх. Операція не повертає полезне навантаження; результат передається через code.

Headers

any

Bodyapplication/json

codeintegerrequired

Код результату повернення 0:Звичайний. Інші коди є винятками.

msgstring or nullrequired

Повідомлення про помилку

requestIdstringrequired

Ідентифікатор запиту на операцію

Response

{
  "code": 0,
  "msg": "",
  "requestId": "efgh5678"
}