비활성화/활성화¶
POST /api/v1/dialing_task/set_disable
개요¶
신서틱 테스트를 일괄 활성화하거나 중지합니다.
호출 전 및 사용 단계¶
먼저 목록/get으로 구성과 현재 상태를 확인한 후 일괄 설정합니다. 일반 작업은 현재 전체 구성을 사용하여 다시 전송하고 항목별로 제출합니다. DNS 활성화 시 DNS 구조/변수를 다시 검증합니다. 모바일 활성화 전에는 전체 배치를 사전 검사하여 HTTP가 반드시 HTTPS여야 하는지 확인하고 약관을 검사합니다. 실제로 항목별 활성화 전에도 다시 검사합니다. mobile 활성화는 현재 구성을 먼저 동기화한 후 스위치를 전송하며, 비활성화는 모바일 서비스가 현재 활성화되어 있거나 약관을 다시 수락할 것을 요구하지 않지만 유효한 플랫폼 바인딩은 여전히 필요합니다. 원격 호출이 없는 로컬 스위치가 아닙니다.
기본적으로 현재 워크스페이스의 삭제되지 않은 일치 객체만 처리합니다. 빈 배열이거나 모두 일치하지 않는 경우에도 true로 성공할 수 있으며, 항목별 일치 목록은 반환하지 않습니다. 작업 간/원격과 로컬은 원자적 배치가 아닙니다. 앞 항목이 이미 제출되었고 뒤 항목이 실패해도 전체가 롤백되지 않습니다. 오류 발생 후에는 먼저 각 task.status와 목록 존재 여부를 다시 읽어 확인합니다. mobile remoteStatus는 항상 unknown이며 미실행을 의미하지 않으므로, 오류 taskUUID/outcomeUnknown에 따라 플랫폼을 확인합니다. 알 수 없는 결과에 대해 무작정 동시 재시도하는 것을 피합니다.
이 OpenAPI 모듈에는 Front 디버깅/가져오기와 동일한 이름의 공개 진입점이 없으므로, 이를 근거로 추측 URL을 구성하지 마십시오. 구성 활성화는 측정 결과를 획득했거나 알림이 전달되었음을 의미하지 않습니다.
일반 레거시 HTTP/TCP/ICMP/SSL/multi/browser/NetPath는 중지 또는 삭제를 전송할 때 여전히 해당 유형 검증을 트리거할 수 있습니다. DNS 중지/삭제만 DNS 계약을 건너뛰며, TCP 중지/삭제는 success_when 키만 요구하고 timeout/connection을 다시 검증하지 않습니다. 중지/삭제를 일괄적으로 기존 구성을 무시하는 것으로 설명해서는 안 됩니다.
요청 헤더¶
| 매개변수명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예: <DF-API-KEY>획득 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 획득합니다. |
Body 요청 매개변수¶
| 매개변수명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| taskUUIDs[*] | string | 작업 이름, 노드 또는 업스트림 taskId가 아닙니다. 예: dial_example획득 또는 입력 방법: 현재 워크스페이스의 단일 작업 UUID를 가져옵니다. |
|
| isDisable | boolean | Y | 필수 불리언이며 task.status=stop/ok를 업데이트합니다. 엔터티나 원본 신서틱 테스트 이력을 삭제하지 않습니다. null 허용: False 예: true획득 또는 입력 방법: true는 중지, false는 활성화입니다. |
| taskUUIDs | array | Y | 필수 배열이며 비어 있지 않을 것을 권장합니다. dial_ 작업만 선택해야 하며 노드/템플릿/원격 id를 혼합할 수 없습니다. 일치하지 않거나 삭제된 UUID는 항목별로 오류를 보고하지 않습니다. null 허용: False 예: ["dial_example"]획득 또는 입력 방법: 신서틱 테스트 목록에서 현재 워크스페이스의 삭제되지 않은 작업 uuid를 가져옵니다. |
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/dialing_task/set_disable' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"taskUUIDs":["dial_example"],"isDisable":true}'
응답¶
HTTP 200, application/json. 아래 예시는 직접 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content | boolean | 성공 시 true입니다. 일치 건수/항목별 결과가 아니며, 원격에서 한 번의 실행이 완료되었음을 보장하지도 않습니다. |
{
"code": 200,
"content": true,
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하십시오.
일반 SDK는 dialtesting.invalidRegion을 ft.DialingRegionError에 매핑하고 실제 HTTP를 유지합니다. 기타 다운스트림 4xx는 실제 HTTP 및 error_code/message를 유지하며, 나열되지 않은 코드도 나타날 수 있습니다. 일반 5xx는 500 ft.InternalServerError로 통일됩니다. mobile 실패에는 taskUUID/remoteStatus/outcomeUnknown이 첨부될 수 있으며, 오류가 반환될 때 앞 항목은 이미 제출되었을 수 있습니다. 중지/삭제는 모든 기존 작업이 현재 생성 계약을 충족하는지 강제로 다시 검증하지 않으며, 이를 근거로 기존 구성을 다시 활성화할 수 있다고 판단해서는 안 됩니다.
| HTTP 상태 | errorCode | 트리거 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 요청 필드가 누락되었거나 필드 값이 선언된 검증 조건을 위반했습니다. | 매개변수 파싱 실패 | 매개변수 위치, 필드명, 유형 및 값을 확인합니다. |
| 400 | ft.RequestJsonFormatError | 요청 JSON 구문이 유효하지 않습니다. | 요청 JSON 형식 오류 | content.reason, line, column에 따라 JSON을 수정합니다. |
| 400 | ft.JsonFormatError | Body 최상위가 객체가 아닙니다. | 일부 json 파일 형식 오류 | taskUUIDs 및 해당 스위치를 포함하는 JSON 객체를 제출합니다. |
| 409 | ft.MobileDialingOperationBusy | 모바일 작업이 포함된 배치가 워크스페이스 동시 작업 잠금을 기다리다 시간 초과되어 이번 작업을 실행하지 않았습니다. | 현재 워크스페이스에서 다른 작업이 진행 중이므로 이번 작업이 실행되지 않았습니다. 잠시 후 다시 시도하십시오. | retryable/operationExecuted에 따라 백오프 재시도합니다. |
| 404 | ft.NotFoundDialTask | 대기 중 원래 모바일 작업이 삭제되었거나 컬렉션이 변경되었습니다. | 지정한 클라우드 신서틱 테스트를 찾을 수 없습니다. | 현재 목록을 다시 읽은 후 대상을 선택합니다. |
| 406 | ft.NotFoundWorkspace | 쓰기 대상 워크스페이스가 더 이상 존재하지 않습니다. | 지정한 워크스페이스를 찾을 수 없습니다. | 워크스페이스가 유효한지 확인하고, 해제된 워크스페이스에 대해서는 재시도하지 않습니다. |
| 406 | ft.DialingBrandNoSetError | 일반 작업 전송에 해당 서비스 구성이 누락되었습니다. | {} 브랜드의 신서틱 테스트 구성이 설정되지 않았습니다. |
관리자가 워크스페이스의 신서틱 테스트 서비스를 확인합니다. |
| 400 | ft.DialingAKNoSetError | 일반 신서틱 테스트 전송에 서명 정보가 누락되었습니다. | 신서틱 테스트 AK 정보가 구성되지 않았습니다. Launcher 활성화 구성을 확인하십시오. | 관리자가 서비스 활성화를 확인합니다. |
| 400 | ft.DialingServerError | 모바일 플랫폼 바인딩/원격 호출 실패 또는 일반 다운스트림 400 실패입니다. | 신서틱 테스트 서비스 인터페이스 호출 실패 | content.reason/taskUUID/outcomeUnknown 및 이미 제출된 하위 집합을 확인하여 중복 작업을 피합니다. |
| 400 | ft.DialingRegionError | 일반 신서틱 테스트 다운스트림 400에서 노드 무효 판정 | 현재 작업에 일부 신서틱 테스트 노드가 유효하지 않습니다. 구성을 업데이트한 후 다시 저장하십시오. | 유효하지 않은 노드 및 현재 작업 상태를 확인합니다. 중지/삭제와 재구성 의도는 다르므로 필요 시 관리자가 처리합니다. |
| 500 | ft.InternalServerError | 일반 다운스트림 5xx/연결 예외 또는 포착되지 않은 데이터베이스, 구성 형식, 참조 처리 오류입니다. | 내부 오류 | 이미 제출된 하위 집합과 원격 상태를 다시 읽고, traceId를 제공한 후 단계별로 처리합니다. |
| 400 | ft.ParamsValidateError | 모바일 활성화 시 HTTP가 HTTPS가 아님, DNS/TCP 활성화 구성이 유효하지 않음, 또는 레거시 NetPath/browser가 활성화/중지 전송 전에 계약을 충족하지 않음 | 매개변수 검증 실패: {} | 실제 유형에 따라 수정합니다. DNS 중지/삭제는 DNS 계약을 건너뛰고, TCP 중지/삭제는 success_when만 검사하며 모든 연결 조건을 다시 검증하지 않습니다. |
| 403 | ft.MobileDialTermsNotAccepted | 모바일 활성화 전에 워크스페이스에서 약관을 확인하지 않았습니다. | 먼저 워크스페이스 Owner 또는 관리자가 모바일 신서틱 테스트 사용 약관을 확인해야 합니다. | 로그인 상태의 워크스페이스 Owner/관리자가 읽고 확인합니다. |
| 400 | ft.InvalidAction | 모바일 활성화 시 기능이 활성화되지 않았거나 현재 작업 상태에서 허용되지 않습니다. | 유효하지 않은 작업 | reason을 확인하고 관리자가 가용성을 확인합니다. 비활성화 상태에서도 중지/삭제를 시도할 수 있습니다. |
| 404 | ft.ObjectNotExists | DNS 활성화 시 참조 변수가 현재 워크스페이스의 유효한 집합에 속하지 않습니다. | 지정한 객체가 존재하지 않습니다. | 먼저 변수 참조를 수정합니다. |
| 406 | ft.InvalidCrontabFormat | 레거시 NetPath의 schedule_type=crontab이고 표현식이 유효하지 않으며, 활성화/중지/삭제 전송 전에 여전히 검증합니다. | 유효하지 않은 crontab 형식 | 먼저 전체 NetPath 구성을 수정하거나 관리자가 처리합니다. NetPath는 DNS/TCP 종료 검증 면제를 받지 않습니다. |
| 406 | ft.MissingSuccessWhen | 일반 레거시 HTTP에 스크립트 대체가 없거나, TCP/ICMP/SSL 등의 저장 구성에 success_when이 누락되었습니다. 중지/삭제에서도 검증할 수 있습니다. | 사용 가능한 판단 기준 success_when이 누락되었습니다. |
먼저 기존 구성과 프로토콜을 확인합니다. DNS 중지/삭제는 DNS 계약을 건너뛰지만, TCP 중지/삭제는 여전히 해당 키를 요구합니다. |
| 406 | ft.MissingMethod | 일반 HTTP 또는 다단계 HTTP 저장 단계에 method가 누락되었습니다. 중지/삭제 전송도 포함됩니다. | 요청 메서드 method가 지정되지 않았습니다. |
전체 기존 구성을 수정하거나 관리자가 비정상 작업을 처리한 후 작업합니다. |
| 400 | ft.MissingCustomParameters | SSL 저장 구성에 host/port가 누락되었거나 NetPath의 엄격한 필수 필드가 누락되었습니다. | {} 필드 누락 | 원래 유형에 따라 수정합니다. 중지/삭제가 이러한 검사를 일괄적으로 건너뛰지 않습니다. |
| 406 | ft.FirstStepsNotWait | 기존 다단계 구성의 첫 번째 단계가 wait이므로 다시 전송하거나 삭제/중지 전 검증에 실패했습니다. | 유효하지 않은 단계 매개변수, 첫 번째 단계는 대기일 수 없습니다. | 다단계 흐름을 수정하거나 관리자가 기존 구성을 처리합니다. |
| 406 | ft.InvalidDialingTask | 레거시 browser 스크립트가 비어 있거나 유효하지 않거나, 레거시 multi HTTP 단계 이름/URL이 유효하지 않습니다. | 유효하지 않은 task 매개변수 | 현재 OpenAPI browser 쓰기는 허용 목록으로 제한되므로 지원 진입점/관리자를 통해 수정한 후 재시도해야 합니다. |