공식 노드 목록¶
GET /api/v1/dialing_task/default_region_list
개요¶
현재 워크스페이스에서 선택 가능한 온라인 기본 신서틱 테스트 노드를 조회합니다.
호출 전 및 사용 단계¶
이 엔드포인트에는 비즈니스 매개변수가 없습니다. 노드 서비스에 owner=default인 활성 노드를 조회한 다음 워크스페이스 버전에 따라 필터링합니다. 무료/체험 워크스페이스에서는 해외 기본 노드를 반환하지 않으며, 특정 워크스페이스 버전에서는 해외 기본 노드만 유지될 수 있습니다. 실제 응답을 기준으로 하며, 고정된 도시 목록을 하드코딩하지 않습니다. 응답은 페이지네이션되지 않고, 노드 이름은 요청 언어에 따라 표시됩니다. 빈 배열은 이번에 선택 가능한 기본 노드가 없음을 의미할 뿐, 모든 자체 호스팅 노드도 존재하지 않는다는 뜻은 아닙니다.
uuid를 일반 작업 regions에 기록합니다. 모바일 작업은 별도의 모바일 리소스에서 제공하는 node/group ID 및 nodeSelection을 사용하며, 혼용할 수 없습니다. 자체 호스팅 노드는 자체 호스팅 노드 목록을 참고하십시오. 노드 도달 가능성은 시간에 따라 변하며, 조회 성공이 대상 인터페이스의 신서틱 테스트 성공을 의미하지는 않습니다.
요청 헤더¶
| 매개변수 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
요청 예시¶
curl --get 'https://openapi.guance.com/api/v1/dialing_task/default_region_list' \
-H 'DF-API-KEY: <DF-API-KEY>'
응답¶
HTTP 200, application/json입니다. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content | array<object> | 현재 선택 가능한 기본 노드 배열이며 []일 수 있습니다. |
| content[].uuid | string | regn_노드 UUID이며, 일반 작업의 regions 생성 시 이 값을 사용합니다. |
| content[].keycode | string | 노드 배포/식별 코드이며, regions UUID로 사용하지 않습니다. |
| content[].owner | string | 이 엔드포인트의 기본 노드는 default입니다. |
| content[].name | string | 현재 요청 언어에 따라 선택된 이름입니다. |
| content[].nameEn | string | 영어 호환 표시 이름입니다. |
| content[].name_en | string | 업스트림의 이전 영어 이름이며 조건부로 유지됩니다. |
| content[].nameI18n | object | 표준 언어 이름 매핑입니다. |
| content[].nameI18n.언어 코드 | string | 해당 언어의 표시 이름입니다. |
| content[].internal | boolean | true는 국내, false는 해외이며 네트워크 사설성을 나타내지 않습니다. |
| content[].country | string | 국가입니다. |
| content[].province | string | 성/도입니다. |
| content[].city | string | 도시입니다. |
| content[].isp | string | 통신사/제공자입니다. |
| content[].status | string | OK/disabled와 같은 노드 서비스 상태이며 작업 실행 상태가 아닙니다. |
| content[].heartbeat | integer | 노드의 최근 하트비트 Unix 초이며 업스트림 정의를 따릅니다. |
| content[].region | string | 업스트림 리전 식별자입니다. |
| content[].company | string | 기업 정보입니다. |
| content[].external_id | string | 자체 호스팅 소속 등 업스트림 필드이며 기본 노드에서는 일반적으로 비어 있습니다. |
| content[].parent_ak | string | 업스트림 호환 소속 필드로 비어 있을 수 있으며, 클라이언트는 이를 OpenAPI Key로 간주하지 않습니다. |
| content[].extend_info | string | 업스트림 확장 JSON 문자열 또는 빈 문자열이며, 기본값이 객체가 아닙니다. |
| content[].create_at | integer | 업스트림 생성 시간 필드로 과거 값이 -1일 수 있으며, 작업 createAt과 구분됩니다. |
| content[].declaration | object | 비어 있지 않은 각 객체의 공통 선언입니다. |
{
"code": 200,
"content": [
{
"uuid": "regn_example",
"keycode": "example-region",
"owner": "default",
"name": "示例节点",
"nameEn": "Example region",
"nameI18n": {
"zh": "示例节点",
"en": "Example region"
},
"internal": true,
"country": "China",
"province": "Zhejiang",
"city": "Hangzhou",
"isp": "example",
"status": "OK",
"heartbeat": 1785427200,
"region": "example-region",
"company": "",
"external_id": "",
"parent_ak": "",
"extend_info": "",
"create_at": -1,
"declaration": {}
}
],
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참고하십시오.
일반 다운스트림 dialtesting.invalidRegion은 ft.DialingRegionError에 매핑되며 HTTP를 유지합니다. 기타 4xx는 실제 HTTP와 error_code를 유지합니다. 나열되지 않은 다른 오류 코드도 반환될 수 있으며, 500 이상은 일괄적으로 500으로 래핑됩니다.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.DialingBrandNoSetError | 워크스페이스에 해당 신서틱 테스트 서비스 구성이 없음 | {} 브랜드의 신서틱 테스트 구성이 설정되지 않았습니다. |
관리자는 신서틱 테스트 서비스 가용성을 확인합니다. |
| 400 | ft.DialingAKNoSetError | 신서틱 테스트 서비스 조회 서명 정보가 구성되지 않음 | 신서틱 테스트 AK 정보가 구성되지 않았습니다. Launcher 활성화 구성을 확인하십시오 | 관리자는 활성화 정보를 확인합니다. |
| 400 | ft.DialingServerError | 일반 노드 서비스가 400 비즈니스 실패를 반환함 | 신서틱 테스트 서비스 인터페이스 호출 실패 | 서비스 상태를 확인하고 traceId를 보존합니다. |
| 500 | ft.InternalServerError | 일반 다운스트림 5xx/연결 예외, 노드 필드 형태 불일치 또는 버전/이름 처리 예외 | 내부 오류 | traceId를 보존하고, 빈 데이터로 가정하거나 이전 노드를 자동으로 사용하지 않도록 하십시오. |