콘텐츠로 이동

다단계 API 테스트 생성



POST /api/v1/dialing_task/multi_task_add

개요

HTTP 요청과 대기 단계로 구성된 다단계 API 테스트를 생성합니다.

호출 전 및 사용 단계

실제 사용 가능한 기본/자체 호스팅 노드에 따라 regions를 선택하고 HTTP와 대기를 포함한 전체 흐름을 생성합니다. 생성 시 type=multi, task.status=ok, 루트 config_vars=[]가 강제되며, 성공 후 즉시 주기에 따라 실행 및 과금될 수 있으므로 이 페이지에서는 type/status/config_vars를 전달하지 않습니다. 첫 번째 단계는 반드시 HTTP여야 합니다.

HTTP 단계 요청 본문은 객체이며, 서버는 저장 전에 JSON 문자열로 변환합니다. 응답의 steps[].task는 객체가 아닙니다. GET/POST/PUT/HEAD만 지원하며 URL은 공개 정규식을 충족해야 합니다. 스크립트/조건은 post_mode와 충돌해서는 안 됩니다. extracted_vars는 구조와 의존성만 검사하며, 현재 check_extracted_vars 온라인 추출 검사를 실행하지 않으므로 field가 실제로 존재하거나 후속 변수 참조가 성공함을 보장하지 않습니다. wait 비즈니스는 1..180초를 명확히 해야 하며, 빈 단계/대기 값 누락은 사전에 거부되지 않을 수 있으나 지원되는 실행 구성으로 간주하지 않습니다.

노드/프로비저닝/데이터베이스 제출은 원자적 트랜잭션이 아니므로 실패 시 이미 원격 실행 구성이 존재할 수 있습니다. 먼저 uuid/이름으로 다시 읽고 중복 생성하지 마십시오. 수정 시 tags를 생략하면 태그가 지워지고 regions는 전체 교체됩니다. 무료/체험 빈도 제한은 일반 작업과 동일합니다. HTTP 고급 항목은 사용자 정의 API 테스트를 참고하여 이해하십시오.

요청 헤더

파라미터 이름 타입 필수 설명
DF-API-KEY string Y 워크스페이스의 OpenAPI 인증 자격 증명입니다.
예: <DF-API-KEY>
가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다.

Body 요청 파라미터

파라미터 이름 타입 필수 설명
regions[*] string 단일 노드 UUID입니다. 프로토콜별 노드 기능은 실제 플랫폼에서 확인해야 합니다.
예: reg_example
가져오기 또는 입력 방법: 현재 사용 가능한 노드 레코드의 uuid를 사용하고, 노드 이름/도시 또는 keycode를 사용하지 않습니다.
tags[*] string 이름 기준 중복 제거이며 tag_ UUID가 아닙니다. API 테스트 스코프에 맞지 않으면 오류가 발생합니다.
예: production
가져오기 또는 입력 방법: 단일 비즈니스 태그 이름을 사용합니다.
task.steps[*] json 단일 단계 객체이며, 선언되지 않은 추가 단계 키는 허용되지 않습니다.
예: {"type": "http", "task": {"name": "检查健康", "method": "GET", "url": "https://example.com/health", "post_mode": "default", "success_when": [{"status_code": [{"is": "200"}]}]}}
가져오기 또는 입력 방법: 필요에 따라 http 요청 또는 wait 대기 단계를 선택합니다.
task.steps[*].type string 필수이며 http/wait입니다.
예: http
가져오기 또는 입력 방법: 실제 HTTP 흐름 및 단계 요구 사항에 따라 구성합니다.
task.steps[*].allow_failure boolean http에서만 선택 가능합니다. 실패 시 후속 단계를 계속할지 여부이며, 전체 작업 성공을 보장하는 것은 아닙니다.
예: false
가져오기 또는 입력 방법: 실제 HTTP 흐름 및 단계 요구 사항에 따라 구성합니다.
task.steps[*].stepId string 선택 사항인 비어 있지 않은 단계 식별자입니다. 추가 시 생략하면 서버가 생성하며, 수정 시 모든 stepId가 무조건 재생성되므로 안정적인 외부 참조를 유지하는 데 사용하지 마십시오.
예: STEP-ID
가져오기 또는 입력 방법: 실제 HTTP 흐름 및 단계 요구 사항에 따라 구성합니다.
task.steps[*].value integer wait 대기 초 수입니다. 비즈니스상 1..180이어야 하며, 현재 검증은 정수이고 ≤180만 확인하고 필수 여부나 하한을 강제하지 않으므로 음수/생략의 정의되지 않은 실행 동작에 의존하지 마십시오.
예: 5
가져오기 또는 입력 방법: 실제 HTTP 흐름 및 단계 요구 사항에 따라 구성합니다.
task.steps[*].extracted_vars array 선택 사항인 추출 변수 배열이며, field가 실제로 생성되는지 스크립트를 현장에서 실행해 검증하지 않습니다.
예: []
가져오기 또는 입력 방법: 실제 HTTP 흐름 및 단계 요구 사항에 따라 구성합니다.
task.steps[*].task json HTTP 단계 비즈니스에 필요한 요청 객체이며 아래 표의 필드로만 제한됩니다. wait에는 포함하지 마십시오.
예: {}
가져오기 또는 입력 방법: 실제 HTTP 흐름 및 단계 요구 사항에 따라 구성합니다.
task.steps[*].extracted_vars[*].name string name/field/secure 중 하나라도 있으면 나머지 두 개도 제공해야 합니다. 선택 배열의 각 항목은 완전한 객체로 제출해야 합니다. 변수 이름입니다.
예: TOKEN
가져오기 또는 입력 방법: 단계 post_script에서 실제로 생성되는 필드와 후속 참조 정의에서 가져옵니다.
task.steps[*].extracted_vars[*].field string name/field/secure 중 하나라도 있으면 나머지 두 개도 제공해야 합니다. 선택 배열의 각 항목은 완전한 객체로 제출해야 합니다. 현재 단계 스크립트 출력에서 추출할 필드이며 직접적인 변수 값이 아닙니다.
예: token
가져오기 또는 입력 방법: 단계 post_script에서 실제로 생성되는 필드와 후속 참조 정의에서 가져옵니다.
task.steps[*].extracted_vars[*].secure boolean name/field/secure 중 하나라도 있으면 나머지 두 개도 제공해야 합니다. 선택 배열의 각 항목은 완전한 객체로 제출해야 합니다. 보안 변수 여부이며 실행 플랫폼에서 처리합니다. 이 인터페이스가 임의 값을 현장에서 검증/암호화함을 의미하지 않습니다.
예: true
가져오기 또는 입력 방법: 단계 post_script에서 실제로 생성되는 필드와 후속 참조 정의에서 가져옵니다.
task.steps[*].task.name string 필수이며 비어 있지 않은 단계 요청 이름입니다.
예: 检查健康
가져오기 또는 입력 방법: 현재 단계의 대상 API와 검증된 HTTP 판단 구성을 기반으로 구성합니다.
task.steps[*].task.method string 필수이며 GET/POST/PUT/HEAD입니다. 일반 HTTP의 임의 메서드를 그대로 적용할 수 없습니다.
예: GET
가져오기 또는 입력 방법: 현재 단계의 대상 API와 검증된 HTTP 판단 구성을 기반으로 구성합니다.
task.steps[*].task.url string 필수이며 비어 있지 않은 절대 HTTP(S) URL이고 현재 도메인/TLD 정규식을 통과해야 합니다. 원시 IP/localhost/템플릿 주소는 이 공개 검증에서 거부될 수 있으므로 먼저 실제 대상으로 검증하십시오.
예: https://example.com/health
가져오기 또는 입력 방법: 현재 단계의 대상 API와 검증된 HTTP 판단 구성을 기반으로 구성합니다.
task.steps[*].task.advance_options json 선택 사항인 HTTP 요청/인증/Body/인증서 등 고급 객체입니다.
예: {}
가져오기 또는 입력 방법: 현재 단계의 대상 API와 검증된 HTTP 판단 구성을 기반으로 구성합니다.
task.steps[*].task.success_when array 기본 판단 시 제공해야 하며, post_mode=default일 때만 포함할 수 있고, 스크립트가 비어 있지 않으면 일반 HTTP 필수 조건을 대체할 수 있습니다.
예: [{"status_code": [{"is": "200"}]}]
가져오기 또는 입력 방법: 현재 단계의 대상 API와 검증된 HTTP 판단 구성을 기반으로 구성합니다.
task.steps[*].task.success_when_logic string and/or이며 post_mode=default일 때만 포함할 수 있습니다.
예: and
가져오기 또는 입력 방법: 현재 단계의 대상 API와 검증된 HTTP 판단 구성을 기반으로 구성합니다.
task.steps[*].task.post_mode string 필수이며 default/script입니다. 생략 가능한 기본 필드가 아닙니다.
예: default
가져오기 또는 입력 방법: 현재 단계의 대상 API와 검증된 HTTP 판단 구성을 기반으로 구성합니다.
task.steps[*].task.post_script string post_mode=script일 때만 포함할 수 있으며 검증된 Pipeline 스크립트를 제공합니다. 비어 있지 않으면 success_when을 대체할 수 있습니다.
예:
가져오기 또는 입력 방법: 현재 단계의 대상 API와 검증된 HTTP 판단 구성을 기반으로 구성합니다.
task.steps[*].task.advance_options.request_options json HTTP/WebSocket에 적용되며 선택 사항입니다. HTTP/WebSocket 요청 옵션입니다.
예: {}
가져오기 또는 입력 방법: 대상 HTTP 인터페이스/노드 구성 및 사용자 정의 API 테스트에 따라 구성합니다.
task.steps[*].task.advance_options.request_options.follow_redirect boolean HTTP/WebSocket에 적용되며 선택 사항입니다. 리디렉션을 따를지 여부이며, 생략 시 실행 측 기본값을 따릅니다.
예: false
가져오기 또는 입력 방법: 대상 HTTP 인터페이스/노드 구성 및 사용자 정의 API 테스트에 따라 구성합니다.
task.steps[*].task.advance_options.request_options.headers json HTTP/WebSocket에 적용되며 선택 사항입니다. 요청 헤더 이름에서 문자열 값으로의 매핑입니다. 실제 자격 증명을 예시에 기록하지 마십시오.
예: {"Accept": "application/json"}
가져오기 또는 입력 방법: 대상 HTTP 인터페이스/노드 구성 및 사용자 정의 API 테스트에 따라 구성합니다.
task.steps[*].task.advance_options.request_options.headers.请求头名 string HTTP/WebSocket에 적용되며 선택 사항입니다. 동적 요청 헤더 값이며, 이름은 실제 인터페이스에 필요한 header를 사용합니다.
예: application/json
가져오기 또는 입력 방법: 대상 HTTP 인터페이스/노드 구성 및 사용자 정의 API 테스트에 따라 구성합니다.
task.steps[*].task.advance_options.request_options.cookies string HTTP/WebSocket에 적용되며 선택 사항입니다. Cookie 텍스트이며 생략할 수 있습니다.
예:
가져오기 또는 입력 방법: 대상 HTTP 인터페이스/노드 구성 및 사용자 정의 API 테스트에 따라 구성합니다.
task.steps[*].task.advance_options.request_options.auth json HTTP/WebSocket에 적용되며 선택 사항입니다. HTTP Basic 사용자 이름/비밀번호 구성이며 생략할 수 있습니다.
예: {}
가져오기 또는 입력 방법: 대상 HTTP 인터페이스/노드 구성 및 사용자 정의 API 테스트에 따라 구성합니다.
task.steps[*].task.advance_options.request_options.auth.username string HTTP/WebSocket에 적용되며 선택 사항입니다. Basic 사용자 이름이며 대상 인터페이스 관리자가 제공합니다.
예: USER-PLACEHOLDER
가져오기 또는 입력 방법: 대상 HTTP 인터페이스/노드 구성 및 사용자 정의 API 테스트에 따라 구성합니다.
task.steps[*].task.advance_options.request_options.auth.password string HTTP/WebSocket에 적용되며 선택 사항입니다. Basic 비밀번호이며 보안 자격 증명 소스에서 주입하십시오.
예: PASSWORD-PLACEHOLDER
가져오기 또는 입력 방법: 대상 HTTP 인터페이스/노드 구성 및 사용자 정의 API 테스트에 따라 구성합니다.
task.steps[*].task.advance_options.request_body json HTTP/WebSocket에 적용되며 선택 사항입니다. 요청 Body 형식과 내용입니다.
예: {}
가져오기 또는 입력 방법: 대상 HTTP 인터페이스/노드 구성 및 사용자 정의 API 테스트에 따라 구성합니다.
task.steps[*].task.advance_options.request_body.body_type string HTTP/WebSocket에 적용되며 선택 사항입니다. 요청 Content-Type입니다. 예: application/json/text/plain/text/xml/multipart/form-data.
예: application/json
가져오기 또는 입력 방법: 대상 HTTP 인터페이스/노드 구성 및 사용자 정의 API 테스트에 따라 구성합니다.
task.steps[*].task.advance_options.request_body.body string HTTP/WebSocket에 적용되며 선택 사항입니다. 요청 본문 문자열입니다. 수정 시 필요한 비즈니스 내용을 유지해야 합니다.
예: {"check":true}
가져오기 또는 입력 방법: 대상 HTTP 인터페이스/노드 구성 및 사용자 정의 API 테스트에 따라 구성합니다.
task.steps[*].task.advance_options.request_body.form json HTTP/WebSocket에 적용되며 선택 사항입니다. multipart 폼 필드에서 문자열로의 매핑이며 생략할 수 있습니다.
예: {"check": "true"}
가져오기 또는 입력 방법: 대상 HTTP 인터페이스/노드 구성 및 사용자 정의 API 테스트에 따라 구성합니다.
task.steps[*].task.advance_options.request_body.form.字段名 string HTTP/WebSocket에 적용되며 선택 사항입니다. 단일 폼 값입니다.
예: true
가져오기 또는 입력 방법: 대상 HTTP 인터페이스/노드 구성 및 사용자 정의 API 테스트에 따라 구성합니다.
task.steps[*].task.advance_options.request_timeout string HTTP/WebSocket에 적용되며 선택 사항입니다. HTTP 전체 타임아웃 duration이며 실행 측 기본값은 60s입니다. Studio는 실제 실행 측 검증을 대체하지 않습니다.
예: 60s
가져오기 또는 입력 방법: 대상 HTTP 인터페이스/노드 구성 및 사용자 정의 API 테스트에 따라 구성합니다.
task.steps[*].task.advance_options.protocol string HTTP/WebSocket에 적용되며 선택 사항입니다. HTTP 프로토콜 auto/http/1.1/http/2/http/2-only/http/3이며 지원 여부는 노드 버전에 따라 다릅니다. HTTP3 사용 시 프록시를 동시에 구성하지 마십시오.
예: auto
가져오기 또는 입력 방법: 대상 HTTP 인터페이스/노드 구성 및 사용자 정의 API 테스트에 따라 구성합니다.
task.steps[*].task.advance_options.certificate json HTTP/WebSocket에 적용되며 선택 사항입니다. 요청 TLS 인증서 구성입니다.
예: {}
가져오기 또는 입력 방법: 대상 HTTP 인터페이스/노드 구성 및 사용자 정의 API 테스트에 따라 구성합니다.
task.steps[*].task.advance_options.certificate.ignore_server_certificate_error boolean HTTP/WebSocket에 적용되며 선택 사항입니다. 인증서 검증 오류를 무시할지 여부입니다.
예: false
가져오기 또는 입력 방법: 대상 HTTP 인터페이스/노드 구성 및 사용자 정의 API 테스트에 따라 구성합니다.
task.steps[*].task.advance_options.certificate.certificate string HTTP/WebSocket에 적용되며 선택 사항입니다. PEM 클라이언트 인증서이며 대상 서비스에서 제공합니다.
예: CERTIFICATE-PLACEHOLDER
가져오기 또는 입력 방법: 대상 HTTP 인터페이스/노드 구성 및 사용자 정의 API 테스트에 따라 구성합니다.
task.steps[*].task.advance_options.certificate.private_key string HTTP/WebSocket에 적용되며 선택 사항입니다. 인증서에 대응하는 PEM 개인 키이며 보안 소스를 사용합니다.
예: PRIVATE-KEY-PLACEHOLDER
가져오기 또는 입력 방법: 대상 HTTP 인터페이스/노드 구성 및 사용자 정의 API 테스트에 따라 구성합니다.
task.steps[*].task.advance_options.certificate.ca string HTTP/WebSocket에 적용되며 선택 사항입니다. CA 내용입니다. 일부 HTTP 실행 측은 보존하지만 사용하지 않으며, DNS는 certificate.ca를 해당 프로토콜에 따라 해석합니다.
예: CA-PLACEHOLDER
가져오기 또는 입력 방법: 대상 HTTP 인터페이스/노드 구성 및 사용자 정의 API 테스트에 따라 구성합니다.
task.steps[*].task.advance_options.proxy json HTTP/WebSocket에 적용되며 선택 사항입니다. HTTP 프록시 객체입니다. 노드가 임의의 프록시에 접근할 수 있다고 가정할 수 없습니다.
예: {}
가져오기 또는 입력 방법: 대상 HTTP 인터페이스/노드 구성 및 사용자 정의 API 테스트에 따라 구성합니다.
task.steps[*].task.advance_options.proxy.url string HTTP/WebSocket에 적용되며 선택 사항입니다. 프록시 URL입니다.
예: http://proxy.example.com:8080
가져오기 또는 입력 방법: 대상 HTTP 인터페이스/노드 구성 및 사용자 정의 API 테스트에 따라 구성합니다.
task.steps[*].task.advance_options.proxy.headers json HTTP/WebSocket에 적용되며 선택 사항입니다. 프록시 전용 문자열 header 매핑입니다.
예: {}
가져오기 또는 입력 방법: 대상 HTTP 인터페이스/노드 구성 및 사용자 정의 API 테스트에 따라 구성합니다.
task.steps[*].task.advance_options.proxy.headers.请求头名 string HTTP/WebSocket에 적용되며 선택 사항입니다. 단일 프록시 요청 헤더 값입니다.
예: VALUE-PLACEHOLDER
가져오기 또는 입력 방법: 대상 HTTP 인터페이스/노드 구성 및 사용자 정의 API 테스트에 따라 구성합니다.
task.steps[*].task.advance_options.secret json HTTP/WebSocket에 적용되며 선택 사항입니다. 레거시 HTTP 요청 데이터 저장 옵션이며 실행 측 지원 여부를 기준으로 합니다.
예: {}
가져오기 또는 입력 방법: 대상 HTTP 인터페이스/노드 구성 및 사용자 정의 API 테스트에 따라 구성합니다.
task.steps[*].task.advance_options.secret.not_save boolean HTTP/WebSocket에 적용되며 선택 사항입니다. 요청 내용을 저장하지 않을지 여부이며, 반환 문서/로그의 마스킹을 대체할 수 없습니다.
예: true
가져오기 또는 입력 방법: 대상 HTTP 인터페이스/노드 구성 및 사용자 정의 API 테스트에 따라 구성합니다.
task.steps[*].task.success_when[*].body array 선택 사항인 어서션 집합이며 키 이름은 실제 응답을 따릅니다. 실행 측에서 지원하는 비교만 사용하십시오.
예: []
가져오기 또는 입력 방법: 실제 HTTP/WebSocket 응답에서 body 또는 특정 header를 선택합니다.
task.steps[*].task.success_when[*].body[*].contains string 단일 텍스트 비교이며 필요한 작업에 따라 선택합니다. 정규식 의미는 실행 측에서 검증하며, 저장 성공이 일치를 증명하지는 않습니다.
예: healthy
가져오기 또는 입력 방법: 일치시킬 응답 텍스트/유효한 정규식을 사용하며, 응답의 민감한 값을 복사하지 마십시오.
task.steps[*].task.success_when[*].body[*].not_contains string 단일 텍스트 비교이며 필요한 작업에 따라 선택합니다. 정규식 의미는 실행 측에서 검증하며, 저장 성공이 일치를 증명하지는 않습니다.
예: healthy
가져오기 또는 입력 방법: 일치시킬 응답 텍스트/유효한 정규식을 사용하며, 응답의 민감한 값을 복사하지 마십시오.
task.steps[*].task.success_when[*].body[*].is string 단일 텍스트 비교이며 필요한 작업에 따라 선택합니다. 정규식 의미는 실행 측에서 검증하며, 저장 성공이 일치를 증명하지는 않습니다.
예: healthy
가져오기 또는 입력 방법: 일치시킬 응답 텍스트/유효한 정규식을 사용하며, 응답의 민감한 값을 복사하지 마십시오.
task.steps[*].task.success_when[*].body[*].is_not string 단일 텍스트 비교이며 필요한 작업에 따라 선택합니다. 정규식 의미는 실행 측에서 검증하며, 저장 성공이 일치를 증명하지는 않습니다.
예: healthy
가져오기 또는 입력 방법: 일치시킬 응답 텍스트/유효한 정규식을 사용하며, 응답의 민감한 값을 복사하지 마십시오.
task.steps[*].task.success_when[*].body[*].match_regex string 단일 텍스트 비교이며 필요한 작업에 따라 선택합니다. 정규식 의미는 실행 측에서 검증하며, 저장 성공이 일치를 증명하지는 않습니다.
예: healthy
가져오기 또는 입력 방법: 일치시킬 응답 텍스트/유효한 정규식을 사용하며, 응답의 민감한 값을 복사하지 마십시오.
task.steps[*].task.success_when[*].body[*].not_match_regex string 단일 텍스트 비교이며 필요한 작업에 따라 선택합니다. 정규식 의미는 실행 측에서 검증하며, 저장 성공이 일치를 증명하지는 않습니다.
예: healthy
가져오기 또는 입력 방법: 일치시킬 응답 텍스트/유효한 정규식을 사용하며, 응답의 민감한 값을 복사하지 마십시오.
task.steps[*].task.success_when[*].header.响应头名 array 선택 사항인 어서션 집합이며 키 이름은 실제 응답을 따릅니다. 실행 측에서 지원하는 비교만 사용하십시오.
예: []
가져오기 또는 입력 방법: 실제 HTTP/WebSocket 응답에서 body 또는 특정 header를 선택합니다.
task.steps[*].task.success_when[*].header.响应头名[*].contains string 단일 텍스트 비교이며 필요한 작업에 따라 선택합니다. 정규식 의미는 실행 측에서 검증하며, 저장 성공이 일치를 증명하지는 않습니다.
예: healthy
가져오기 또는 입력 방법: 일치시킬 응답 텍스트/유효한 정규식을 사용하며, 응답의 민감한 값을 복사하지 마십시오.
task.steps[*].task.success_when[*].header.响应头名[*].not_contains string 단일 텍스트 비교이며 필요한 작업에 따라 선택합니다. 정규식 의미는 실행 측에서 검증하며, 저장 성공이 일치를 증명하지는 않습니다.
예: healthy
가져오기 또는 입력 방법: 일치시킬 응답 텍스트/유효한 정규식을 사용하며, 응답의 민감한 값을 복사하지 마십시오.
task.steps[*].task.success_when[*].header.响应头名[*].is string 단일 텍스트 비교이며 필요한 작업에 따라 선택합니다. 정규식 의미는 실행 측에서 검증하며, 저장 성공이 일치를 증명하지는 않습니다.
예: healthy
가져오기 또는 입력 방법: 일치시킬 응답 텍스트/유효한 정규식을 사용하며, 응답의 민감한 값을 복사하지 마십시오.
task.steps[*].task.success_when[*].header.响应头名[*].is_not string 단일 텍스트 비교이며 필요한 작업에 따라 선택합니다. 정규식 의미는 실행 측에서 검증하며, 저장 성공이 일치를 증명하지는 않습니다.
예: healthy
가져오기 또는 입력 방법: 일치시킬 응답 텍스트/유효한 정규식을 사용하며, 응답의 민감한 값을 복사하지 마십시오.
task.steps[*].task.success_when[*].header.响应头名[*].match_regex string 단일 텍스트 비교이며 필요한 작업에 따라 선택합니다. 정규식 의미는 실행 측에서 검증하며, 저장 성공이 일치를 증명하지는 않습니다.
예: healthy
가져오기 또는 입력 방법: 일치시킬 응답 텍스트/유효한 정규식을 사용하며, 응답의 민감한 값을 복사하지 마십시오.
task.steps[*].task.success_when[*].header.响应头名[*].not_match_regex string 단일 텍스트 비교이며 필요한 작업에 따라 선택합니다. 정규식 의미는 실행 측에서 검증하며, 저장 성공이 일치를 증명하지는 않습니다.
예: healthy
가져오기 또는 입력 방법: 일치시킬 응답 텍스트/유효한 정규식을 사용하며, 응답의 민감한 값을 복사하지 마십시오.
task.steps[*].task.success_when[*].header json 선택 사항인 header 이름에서 조건 집합으로의 매핑입니다.
예: {}
가져오기 또는 입력 방법: 실제 응답 header 이름을 사용합니다.
task.steps[*].task.success_when[*].status_code array HTTP 선택 사항인 상태 어서션 집합이며 실행 측 프로토콜에 따라 문자열을 비교합니다.
예: [{"is": "200"}]
가져오기 또는 입력 방법: 성공 HTTP 상태 코드 또는 대응 정규식을 선택합니다.
task.steps[*].task.success_when[*].status_code[*].is string 단일 상태 코드 어서션 작업입니다. mobile expectedResponseCode 정수 배열과 혼용하지 마십시오.
예: 200
가져오기 또는 입력 방법: 대상 인터페이스의 기대 상태/상태 정규식을 사용합니다.
task.steps[*].task.success_when[*].status_code[*].is_not string 단일 상태 코드 어서션 작업입니다. mobile expectedResponseCode 정수 배열과 혼용하지 마십시오.
예: 200
가져오기 또는 입력 방법: 대상 인터페이스의 기대 상태/상태 정규식을 사용합니다.
task.steps[*].task.success_when[*].status_code[*].match_regex string 단일 상태 코드 어서션 작업입니다. mobile expectedResponseCode 정수 배열과 혼용하지 마십시오.
예: 200
가져오기 또는 입력 방법: 대상 인터페이스의 기대 상태/상태 정규식을 사용합니다.
task.steps[*].task.success_when[*].status_code[*].not_match_regex string 단일 상태 코드 어서션 작업입니다. mobile expectedResponseCode 정수 배열과 혼용하지 마십시오.
예: 200
가져오기 또는 입력 방법: 대상 인터페이스의 기대 상태/상태 정규식을 사용합니다.
task.steps[*].task.success_when[*].response_time string HTTP duration 임계값이며 TCP 레거시 소요 시간 배열이 아닙니다.
예: 100ms
가져오기 또는 입력 방법: 대상 HTTP 전체 응답 소요 시간 요구 사항에 따라 설정합니다.
regions array Y 필수 배열입니다. 일반 작업은 비어 있지 않아야 하며, 모바일 작업은 명시적으로 []여야 하고 대신 task.nodeSelection을 사용합니다. 수정 시 노드 집합을 전체 교체하며, 노드를 제거하면 원래 노드에 중지 프로비저닝이 전송됩니다.
null 허용: False
예: ["reg_example"]
가져오기 또는 입력 방법: 사용 가능한 노드 목록 또는 기본 리전 목록에서 실제 노드 uuid를 가져옵니다.
tags array 선택 사항이며 기본값은 []입니다. 수정 시 생략하거나 []이면 태그 관계가 지워집니다. 모바일 작업은 아웃바운드 태그도 동기화하며 클라이언트의 dfLabel/extendConfig를 허용하지 않습니다.
null 허용: False
예: ["production"]
가져오기 또는 입력 방법: 태그 목록에서 dialing/all 스코프에 적용되는 이름을 가져오며 UUID가 아닙니다.
task json Y 필수 전체 객체이며 maxDictLength=20000은 서버 딕셔너리 가중 길이로 계산됩니다. 단일 HTTP 작업 또는 문자열이 아닙니다. 수정 시 단계/태그/노드를 전체 교체합니다.
null 허용: False
딕셔너리 길이 상한: 20000
예: {}
가져오기 또는 입력 방법: 이 페이지의 다단계 프로토콜에 따라 HTTP 요청과 대기 단계를 조합합니다.
task.desc string 선택 사항이며 빈 문자열일 수 있습니다. 생략 시 이전 값이 유지된다고 보장하지 않습니다.
빈 문자열 허용: True
null 허용: False
예: 登录后检查API
가져오기 또는 입력 방법: 비즈니스 담당자가 흐름 용도를 설명합니다.
task.frequency string Y 필수이며 기본값이 없습니다. 무료/체험 워크스페이스는 30m/1h/6h/12h/24h만 가능합니다. DataKit 수동 JSON의 임의 초 단위 빈도를 그대로 적용하지 마십시오.
null 허용: False
선택 가능 값: ['1m', '5m', '15m', '30m', '1h', '6h', '12h', '24h']
예: 5m
가져오기 또는 입력 방법: 비즈니스 예산과 실행 요구 사항에 따라 1m/5m/15m/30m/1h/6h/12h/24h 중에서 선택합니다.
task.name string Y 필수이며 trim 후 1..256개의 Python 문자여야 합니다. trim 결과를 저장하며 모든 API 테스트 유형이 삭제되지 않은 이름의 고유성을 공유합니다. 수정 시 전체 이름을 제공해야 합니다.
null 허용: False
예: 站点可用性
가져오기 또는 입력 방법: 비즈니스 담당자가 이 워크스페이스에서 고유한 작업 이름을 정의합니다.
task.steps array Y 필수 배열이며 비즈니스상 비어 있지 않아야 합니다. 공개 검증에서는 minLength를 강제하지 않으므로 빈 배열도 저장까지 진행될 수 있으나 유효한 실행을 보장하지 않습니다. 첫 번째 단계는 wait일 수 없습니다.
null 허용: False
예: []
가져오기 또는 입력 방법: 실행 순서에 따라 HTTP와 wait 단계를 구성합니다.

파라미터 추가 설명

다단계 HTTP 고급 항목은 사용자 정의 API 테스트를 참고하고, 전체 단계 구조와 현재 공개 검증 경계는 이 페이지의 파라미터 표를 참고하십시오.

요청 예시

curl --request POST 'https://openapi.guance.com/api/v1/dialing_task/multi_task_add' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"regions":["reg_example"],"task":{"name":"多步健康检查","frequency":"5m","desc":"等待后再次读取","steps":[{"type":"http","allow_failure":false,"extracted_vars":[],"task":{"name":"首次检查","method":"GET","url":"https://example.com/health","post_mode":"default","success_when":[{"status_code":[{"is":"200"}]}],"success_when_logic":"and"}},{"type":"wait","value":5},{"type":"http","allow_failure":false,"extracted_vars":[],"task":{"name":"再次检查","method":"GET","url":"https://example.com/health","post_mode":"default","success_when":[{"status_code":[{"is":"200"}]}]}}]},"tags":[]}'

응답

HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.

필드 타입 설명
content.id integer 또는 null 레코드 번호이며, 일반 생성 시 제출 전에 구성된 응답에서는 null일 수 있습니다.
content.uuid string dial_ 작업 UUID이며 이후 get/modify/시작/중지에 사용합니다.
content.workspaceUUID string 소속 워크스페이스 UUID입니다.
content.type string 저장된 작업 범주입니다. mobile의 세부 프로토콜은 task.protocol을 참고하며, 다단계는 multi입니다.
content.status integer 엔터티 상태이며 일반적으로 0, 삭제는 3입니다. task.status 실행 스위치와 구분합니다.
content.isLocked integer 또는 boolean 로컬/워크스페이스 잠금 표시이며 원격 실측 상태를 의미하지 않습니다.
content.regions array<string> 일반 작업의 현재 노드 UUID 배열이며 모바일은 []입니다.
content.regions[] string 노드 UUID입니다.
content.regionsInfo array 또는 object 레거시 노드 표시는 UUID 배열, 객체 배열 또는 UUID 키 매핑일 수 있습니다. 생성/수정 시에는 보통 입력 UUID 배열입니다.
content.regionsInfo[] string 또는 object 노드 UUID 또는 저장된 노드 정보입니다.
content.regionsInfo[].uuid string 조건부로 반환되는 노드 UUID입니다.
content.regionsInfo[].name string 현재 언어의 노드 표시 이름입니다.
content.regionsInfo[].nameEn string 영어/호환 이름입니다.
content.regionsInfo[].nameI18n object 언어에서 이름으로의 매핑입니다.
content.regionsInfo[].nameI18n.语言码 string 단일 표시 이름입니다.
content.regionsInfo.节点UUID string 또는 object 레거시 UUID 키 매핑의 노드 정보이며 배열 노드 정보와 동일한 의미입니다.
content.task object 저장된 작업 전체 구성이며 실시간 API 테스트 결과는 포함하지 않습니다.
content.remoteStatus string mobile은 unknown으로 고정되며 로컬에서만 읽고 플랫폼을 실시간 조회하지 않습니다.
content.creator string 생성 주체입니다.
content.updator string 업데이트 주체입니다.
content.createAt integer 생성 Unix 초입니다.
content.updateAt integer 업데이트 Unix 초입니다.
content.deleteAt integer 삭제 Unix 초이며 삭제되지 않으면 -1입니다.
content.task.name string 다단계 작업 이름입니다.
content.task.frequency string 작업 빈도입니다.
content.task.desc string 작업 설명이며 생략할 수 있습니다.
content.task.status string 공개 다단계 어댑터에서 ok로 기록하며, 수정 시 다시 활성화될 수도 있습니다.
content.task.config_vars array 공개 어댑터에서 고정으로 비어 있으며 루트 수준 변수 구성을 받지 않습니다.
content.task.steps array<object> 저장된 실행 단계입니다.
content.task.steps[].type string http/wait입니다.
content.task.steps[].stepId string 서버 단계 식별자이며 수정 시 재생성됩니다.
content.task.steps[].allow_failure boolean HTTP 실패 시 계속할지 여부입니다.
content.task.steps[].value integer 대기 초 수입니다.
content.task.steps[].extracted_vars array<object> 추출 변수 정의입니다.
content.task.steps[].extracted_vars[].name string 변수 이름입니다.
content.task.steps[].extracted_vars[].field string 추출 필드입니다.
content.task.steps[].extracted_vars[].secure boolean 보안 플래그입니다.
content.task.steps[].task string HTTP 단계 구성은 JSON 문자열로 저장되며 요청 객체와 다릅니다. JSON 디코딩 후 이 페이지의 HTTP 단계 필드에 따라 읽어야 합니다.
content.tagInfo array<object> 유효 태그 요약이며 빈 []입니다. 일반 수정에서는 생략될 수 있고 mobile 수정에서는 반환됩니다. 읽기 시 id는 데이터베이스 숫자이며, 쓰기에서 생성된 요약 id는 태그 UUID 문자열일 수 있습니다.
content.tagInfo[].id integer 또는 string 읽기는 데이터베이스 번호이고 쓰기는 태그 UUID입니다.
content.tagInfo[].uuid string 읽은 태그 UUID이며 쓰기 분기에서는 생략될 수 있습니다.
content.tagInfo[].name string 태그 이름입니다.
content.tagInfo[].description string 읽은 태그 설명입니다.
content.tagInfo[].colour string 읽은 태그 색상입니다.
content.tagInfo[].scope array<string> 쓰기 요약에는 정규화된 스코프가 포함될 수 있습니다.
content.tagInfo[].scope[] string 단일 스코프입니다.
content.declaration object 공통 선언입니다.
{
  "code": 200,
  "content": {
    "id": null,
    "uuid": "dial_example",
    "workspaceUUID": "wksp_example",
    "type": "multi",
    "status": 0,
    "isLocked": false,
    "regions": [
      "reg_example"
    ],
    "regionsInfo": [
      "reg_example"
    ],
    "task": {
      "name": "多步健康检查",
      "frequency": "5m",
      "desc": "等待后再次读取",
      "steps": [
        {
          "type": "http",
          "allow_failure": false,
          "extracted_vars": [],
          "task": "{\"name\": \"首次检查\", \"method\": \"GET\", \"url\": \"https://example.com/health\", \"post_mode\": \"default\", \"success_when\": [{\"status_code\": [{\"is\": \"200\"}]}], \"success_when_logic\": \"and\"}",
          "stepId": "STEP-1"
        },
        {
          "type": "wait",
          "value": 5,
          "stepId": "STEP-2"
        },
        {
          "type": "http",
          "allow_failure": false,
          "extracted_vars": [],
          "task": "{\"name\": \"再次检查\", \"method\": \"GET\", \"url\": \"https://example.com/health\", \"post_mode\": \"default\", \"success_when\": [{\"status_code\": [{\"is\": \"200\"}]}]}",
          "stepId": "STEP-3"
        }
      ],
      "status": "ok",
      "config_vars": []
    },
    "creator": "wsak_example",
    "updator": "wsak_example",
    "createAt": 1785427200,
    "updateAt": 1785427200,
    "deleteAt": -1,
    "tagInfo": [],
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참고하십시오.

일반 다운스트림 dialtesting.invalidRegion은 ft.DialingRegionError로 매핑되고 실제 HTTP 상태 코드를 유지합니다. 기타 4xx는 실제 HTTP 상태 코드와 error_code/message를 유지할 수 있으며, >=500은 500으로 통일합니다. 구성 저장이 각 단계의 실제 성공을 의미하지는 않습니다.

HTTP 상태 errorCode 트리거 조건 메시지 또는 응답 설명 처리 방법
406 ft.ParameterValidationFailed 요청 필드 누락 또는 필드 값이 선언된 검증 조건 위반 파라미터 파싱 실패 파라미터 위치, 필드 이름, 타입 및 값을 확인하십시오.
400 ft.RequestJsonFormatError 요청 JSON 구문이 유효하지 않음 요청 JSON 형식 오류 content.reason, line, column에 따라 JSON을 수정하십시오.
400 ft.JsonFormatError Body 최상위가 JSON 객체가 아님 일부 json 파일 형식 오류 regions/task 등의 필드를 포함한 완전한 JSON 객체를 제출하십시오.
400 ft.InvalidDialingRegion 일반 작업 regions가 비어 있음 유효하지 않은 API 테스트 리전 사용 가능한 노드 목록에서 하나 이상의 실제 노드 UUID를 선택하십시오. 모바일 작업은 예외적으로 반드시 []여야 합니다.
400 ft.ParamsValidateError 작업 이름 또는 단계 type/HTTP 메서드/URL/post_mode/변수 의존성/대기 상한이 이 페이지의 계약을 충족하지 않음 파라미터 검증 실패: {} 다단계 파라미터 표에 따라 전체 단계를 수정하십시오. 일반 HTTP의 임의 메서드/필드를 그대로 적용할 수 없습니다.
406 ft.MissingSuccessWhen 해당 프로토콜에 success_when이 없고 지원되는 스크립트 대체도 없음 사용 가능한 판단 success_when 누락 프로토콜에 따라 완전한 가용성 판단을 제출하십시오.
400 ft.TaskNameRepeat 이 워크스페이스의 삭제되지 않은 작업에 동일 이름이 이미 있음(모든 API 테스트 유형 포함) 현재 워크스페이스에 동일 이름 작업 {}이(가) 이미 있습니다. 기존 UUID를 수정하거나 이름을 변경하십시오. 이름은 trim 후 비교합니다.
403 ft.InvalidTimeFrequency 무료/체험 워크스페이스에서 지원되지 않는 빈도를 사용함 시간 빈도가 유효하지 않음 30m/1h/6h/12h/24h로 변경하거나 버전 지원 여부를 확인하십시오.
400 ft.TagScopeMismatch 태그를 dialing 스코프에 사용할 수 없음 태그 스코프가 일치하지 않음 all/dialing 태그를 사용하거나 확인 후 스코프를 업데이트하십시오.
406 ft.NotFoundWorkspace 쓰기 잠금 시 워크스페이스 레코드가 존재하지 않음 지정된 워크스페이스를 찾을 수 없음 워크스페이스 상태를 확인하고 해제된 워크스페이스에 대한 쓰기를 중지하십시오.
400 ft.DialingServerError 모바일 플랫폼/바인딩/노드 선택/응답 불일치 또는 호출 실패, 또는 일반 다운스트림이 해당 400을 반환함 API 테스트 서비스 인터페이스 호출 실패 content.reason/outcomeUnknown/taskUUID/localSaved에 따라 로컬과 원격 상태를 확인하십시오. 알 수 없는 결과는 무작정 재생성하지 마십시오.
400 ft.DialingRegionError 일반 다운스트림 400이 dialtesting.invalidRegion으로 판정됨 현재 작업에 일부 API 테스트 노드가 유효하지 않습니다. 구성을 업데이트한 후 다시 저장하십시오. 유효하지 않은 노드를 교체한 후 다시 저장하십시오. 기타 HTTP는 아래 오류 범위에 따라 처리하십시오.
500 ft.InternalServerError 포착되지 않은 저장/타입 오류, 일반 API 테스트 다운스트림 5xx, 연결 타임아웃 또는 제출 후 처리 실패 내부 오류 먼저 작업 UUID/이름으로 다시 읽고 프로비저닝 상태를 확인한 후 재시도 여부를 결정하고 traceId를 보존하십시오.
406 ft.FirstStepsNotWait 첫 번째 단계가 wait임 유효하지 않은 단계 파라미터, 첫 번째 단계는 대기일 수 없음 HTTP 요청으로 시작하십시오.
406 ft.InvalidDialingTask 일반 추가 실패 후 중지 보상이 dialtesting.invalidTask를 반환함 유효하지 않은 task 파라미터 먼저 다단계 작업과 원격 프로비저닝 상태를 확인하여 중복 생성을 피하십시오.
406 ft.DialingBrandNoSetError 워크스페이스에 대응하는 일반 API 테스트 서비스가 구성되지 않음 {} 브랜드의 API 테스트 구성이 없습니다. 관리자가 워크스페이스 API 테스트 서비스를 확인하도록 하십시오.
400 ft.DialingAKNoSetError 프로비저닝 서명 자격 증명이 구성되지 않음 API 테스트 AK 정보가 구성되지 않았습니다. Launcher 활성화 구성을 확인하십시오. 관리자가 API 테스트 서비스 활성화 정보를 확인하도록 하십시오.

문서 평가

이 페이지가 도움이 되었나요?