ARNPROXY

연결 목록 생성

POST/account/api/v1/residential/lists/create
작업을 명시적으로 확인하세요

기록, 잔액 또는 서비스 설정이 변경될 수 있습니다. 범위와 주의 사항을 먼저 읽으세요. 결과가 불확실하면 새 작업을 시작하지 말고 같은 작업을 조회하세요.

권한 인증

AuthorizationBearer YOUR_ARNPROXY_API_KEY
필요한 권한residential_management
Acceptapplication/json
Content-Typeapplication/json
Idempotency-Key문자, 숫자, _ 또는 -로 16~100자. 같은 작업에는 저장한 동일 값을 사용하세요.

매개변수

이름유형설명
Idempotency-Key
header필수
string문자/숫자/_/- 16~100자. 작업과 상태 조회에 같은 값을 사용하고 다른 본문에 재사용하지 마세요.
package_id
body필수
integerresidential_packages의 ARNPROXY 패키지 ID이며 공급자의 package_key가 아닙니다.
title
body필수
string비어 있지 않은 UTF-8 텍스트, 최대 255바이트. 제어 문자, < 또는 > 금지.
country
body필수
string대문자 두 글자 국가 코드, 예: US.
region
body선택
string선택적 위치 텍스트, 최대 UTF-8 50바이트. 기본값은 빈 문자열.
기본값: ""
city
body선택
string선택적 위치 텍스트, 최대 UTF-8 50바이트. 기본값은 빈 문자열.
기본값: ""
isp
body선택
string위치 응답의 ISP 텍스트, 최대 UTF-8 50바이트.
port_count
body필수
integer연결 포트 1~1000개.
rotation_seconds
body필수
integer기존 목록 회전 값에 따른 정수 초 -1~3600.
expected_revision
body필수
string해당 범위/설정 조회의 revision: 소문자 16진수 64자.
terms
body필수
boolean명시적 승인에는 JSON 불리언 true를 보내야 하며 문자열 "true"는 안 됩니다.
authentication
body선택
stringlogin_password 또는 ip_auth.
기본값: "login_password"
authorized_ips
body조건부
string[]authentication=ip_auth에서만 고유 공개 IPv4 1~20개. login_password에서는 생략하세요.

요청 본문

YOUR_/FROM_을 해당 카탈로그, 견적 또는 범위의 값으로 바꾸세요. 예제의 동의 값은 false입니다. 실제 작업에 동의할 때만 승인하세요.

request.json
{
    "package_id": "YOUR_PACKAGE_ID",
    "title": "My connection list",
    "country": "US",
    "port_count": 1,
    "rotation_seconds": 0,
    "expected_revision": "FROM_SCOPE_REVISION",
    "terms": false
}

요청 예제

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' \
    --request POST --header 'Content-Type: application/json' \
    --data-binary @request.json \
    'https://www.arnproxy.com/account/api/v1/residential/lists/create'

이 페이지에서는 예제를 실행하지 않습니다. API 키는 서버 환경 변수에 보관하고 URL이나 브라우저 코드에 넣지 마세요. POST 예제에는 request.json을 준비하세요.

응답

200성공 응답
application/json
{
    "ok": true,
    "data": {
        "state": "completed",
        "action": "create",
        "package_id": 20001,
        "list_id": 30001,
        "reason_code": null,
        "replayed": false,
        "credentials_included": false,
        "gb_purchased": 0,
        "balance_changes": 0,
        "package_expiry_changes": 0,
        "manual_review_required": false
    },
    "meta": {
        "request_id": "000000000000000000000001",
        "phase": "public_v1",
        "source": "arnproxy_records"
    }
}
응답 필드 및 유형
이름유형설명
okboolean성공 여부. false이면 error.code를 확인하세요.
dataobject작업별 결과이며 예제는 설명용 합성 데이터입니다.
data.statestring기록/작업 상태. accepted는 배송 완료가 아니며 completed는 연결 테스트가 아닙니다.
data.actionstringaction의 작업별 값입니다. 반환된 유형을 유지하고 동작 설명을 확인하세요.
data.package_idinteger관련 ARNPROXY 기록 ID. 공급자 내부 ID 대신 사용하세요.
data.list_idinteger관련 ARNPROXY 기록 ID. 공급자 내부 ID 대신 사용하세요.
data.reason_codestring|null고정 사유 코드 또는 null이며 원본 공급자 오류 텍스트가 아닙니다.
data.replayedboolean동일 작업의 저장된 결과이며 새 결제/작업의 증거가 아닙니다.
data.credentials_includedboolean결과/키가 민감한 인증 정보를 포함하거나 허용하는지 여부.
data.gb_purchasedinteger트래픽 양. 목록/설정 작업은 트래픽을 구매하지 않습니다.
data.balance_changesinteger보고된 작업 효과. 자동 갱신 설정은 향후 별도의 결제를 유발할 수 있습니다.
data.package_expiry_changesintegerpackage expiry changes의 작업별 값입니다. 반환된 유형을 유지하고 동작 설명을 확인하세요.
data.manual_review_requiredbooleanmanual review required의 작업별 값입니다. 반환된 유형을 유지하고 동작 설명을 확인하세요.
metaobject요청 추적 및 데이터 출처 메타데이터.
meta.request_idstring이 HTTP 요청의 추적 ID이며 작업 키나 주문 ID가 아닙니다.
meta.phasestringphase의 작업별 값입니다. 반환된 유형을 유지하고 동작 설명을 확인하세요.
meta.sourcestring데이터 출처. 로컬 기록과 실시간 공급자 조회는 서로 다른 근거입니다.

오류 응답

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

인증 및 검증 단계에서 실행 전에 요청이 거부될 수 있습니다. 오류 문서를 확인하고 지원 문의용 request_id를 보관하세요. 키나 비밀번호를 보내지 마세요. 오류 및 제한 →

동작 및 주요 참고 사항

  • 패키지와 목록 ID는 ARNPROXY 기록 ID이며 공급자 키가 아닙니다. 오래된 스냅샷은 접근을 허용하지 않습니다. 필요 시 residential_package_refresh를 사용하세요.
  • 새 목록은 login_password 또는 ip_auth를 지원합니다. IP 인증은 고유한 공개 IPv4 1~20개입니다. 목록 삭제는 GB 패키지를 삭제하지 않고 해당 목록 연결만 해제합니다.
  • 시간 초과/5xx는 쓰기 실패의 증거가 아닙니다. 원래 Idempotency-Key로 상태를 조회하고 새 키로 재시도하지 마세요. GET은 변경을 재전송하지 않습니다.
동일한 작업 추적목록 작업 확인 →

현재 언어로 검색합니다. 닫기: Esc