다음을 통해 공유

분석 호출

  • 아티클

분석 작업 시작은 POST 요청을 analyze 경로에 제출하여 수행됩니다. 분석은 일반적으로 1분 이상 지속되는 장기 실행 프로세스일 수 있습니다. API는 먼저 몇 가지 기본 유효성 검사를 수행하고 작업을 제출하여 백엔드에서 요청을 시작한 다음 상태 코드 202와 Location 헤더 또는 적절한 오류 세부 사항으로 응답합니다. Location 헤더 값은 요청 상태를 확인하고 결과의 URL을 얻는 데 사용할 수 있는 URL입니다. 규칙 또는 규칙 세트 목록, 분석에서 제외할 파일 등과 같은 기준에 따라 작업을 조정하는 POST 조치를 통해 다양한 옵션이 있습니다. 다음 [Geographical URL]/api/analyze?api-version=1.0을 사용하여 분석을 시작할 수 있습니다.

노트

상태 확인 사이에 15초에서 60초 사이를 기다리는 것이 좋습니다. 분석은 일반적으로 실행하는 데 1 ~ 5분이 걸립니다.
이 API에는 OAuth 토큰이 필요합니다.

헤더

입력 Type 예상 값 필수 여부
권한 부여 string OAuth ID 애플리케이션 ID 클레임을 포함하는 Microsoft Entra 1 전달 토큰입니다. yes
x-ms-tenant-id GUID 애플리케이션 테넌트의 ID입니다. 예
x-ms-correlation-id GUID 분석 실행의 식별자입니다. 전체 실행(업로드, 분석, 상태)에 동일한 ID를 제공해야 합니다. 예
수락 개체 application/json, application/x-ms-sarif-v2 예
Accept-Language string 언어 코드(예: en-US). 기본값은 en-US입니다. 여러 언어가 제공되는 경우 첫 번째 언어가 기본 언어가 됩니다. 그러나 모든 번역(언어가 지원되는 경우)이 포함됩니다. 아니요

본문

일반적으로 사용되는 옵션:

속성 형식 예상 값 필수 여부
sasUriList 문자열 배열 단일 솔루션, 여러 솔루션 파일이 포함된 zip 파일 또는 패키지를 다운로드하기 위한 서비스 액세스를 제공하는 URI 목록입니다. 예
ruleSets 사용자 지정 배열 0 이상 아니요
ruleSets.id guid 규칙 세트 API를 조회하여 찾을 수 있는 규칙 세트의 ID입니다. 아니요, 그러나 이것은 일반적으로 사용하려는 것입니다. 이것 또는 ruleCodes를 사용해야 합니다.
ruleCodes.code string 규칙 세트 및 규칙 API를 조회하여 찾을 수 있는 원하는 규칙의 ID입니다. 아니요. 이것 또는 ruleSets를 사용해야 합니다.
fileExclusions 문자열 배열 제외할 파일 이름 또는 파일 이름 패턴 목록입니다. 파일 이름의 시작 및/또는 끝에 "*"를 와일드카드로 사용하기 위한 지원이 있습니다(예: *jquery.dll and *jquery*). 없음

예상 응답

HTTP 상태 코드 시나리오 Result
202 분석 요청이 수락되었고 상태 확인 URI가 Location 헤더에 반환되었습니다. 결과 본문이 없음
400 zip 파일이 아닌 파일이 전송되었거나 잘못된 매개 변수가 있거나 파일에 바이러스가 포함됨 결과 본문이 없음
409 중복 x-ms-correlation-id 헤더 값이 있는 요청이 전송됨 결과 본문이 없음

예상 응답 헤더

이름 형식 예상 값 필수 여부
위치 Uri 현재 상태를 쿼리하고 결과를 얻는 데 사용할 URL 예

예: 분석 시작

단일 파일인 AppSource 인증 규칙 집합으로 분석 작업을 시작하고 이름에 jquery 및 json 텍스트가 포함된 파일을 제외하는 예제입니다.

요구

POST [Geographical URI]/api/analyze?api-version=1.0
Accept: application/json
Content-Type: application/json; charset=utf-8
x-ms-correlation-id: aaaa0000-bb11-2222-33cc-444444dddddd
x-ms-tenant-id: aaaabbbb-0000-cccc-1111-dddd2222eeee

{
    "ruleSets": [{
        "id": "0ad12346-e108-40b8-a956-9a8f95ea18c9"
    }],
    "sasUriList": ["https://testenvfakelocation.blob.core.windows.net/mySolution.zip"],
    "fileExclusions": ["*jquery*", "*json*"]
}

응답 #glsr_cfigia ...

HTTP/1.1 202 Accepted
Content-Type: application/json; charset=utf-8
Location: [Geographical URI]/api/status/aaaa0000-bb11-2222-33cc-444444dddddd&api-version=1.0

참조

Power Apps 체커 웹 API를 사용하세요
규칙 세트 목록을 검색합니다
규칙 목록을 검색합니다
파일 업로드
분석 상태 확인