다음을 통해 공유


상업용 Marketplace에 대한 보고서 쿼리 API 가져오기

보고서 가져오기 쿼리 API는 보고서에서 사용할 수 있는 모든 쿼리를 가져옵니다. 기본적으로 모든 시스템 및 사용자 정의 쿼리를 가져옵니다.

요청 구문

방법 요청 URI
GET https://api.partnercenter.microsoft.com/insights/v1.1/cmp/ScheduledQueries?queryId={QueryID}&queryName={QueryName}&includeSystemQueries={include_system_queries}&includeOnlySystemQueries={include_only_system_queries}

요청 헤더

Header Type 설명
권한 부여 string 필수입니다. 양식의 Microsoft Entra 액세스 토큰 Bearer <token>
콘텐츠-종류 string Application/JSON

경로 매개 변수

None

쿼리 매개 변수

매개 변수 이름 Type 필요함 설명
queryId string 아니요 인수에 지정된 ID를 사용하여 쿼리에 대한 세부 정보만 가져오도록 필터링
queryName string 아니요 인수에 지정된 이름을 가진 쿼리에 대한 세부 정보만 가져오는 필터
IncludeSystemQueries 부울 값 아니요 응답에 미리 정의된 시스템 쿼리를 포함합니다. 기본값은 True입니다.
IncludeOnlySystemQueries 부울 값 아니요 응답에 시스템 쿼리만 포함합니다. 기본값은 False입니다 .

요청 페이로드

None

용어 설명

None

Response

응답 페이로드는 다음과 같이 구성됩니다.

응답 코드: 200, 400, 401, 403, 404, 500

응답 페이로드:

{
  "Value": [
    {
      "QueryId": "string",
      "Name": "string",
      "Description": "string",
      "Query": "string",
      "Type": "string",
      "User": "string",
      "CreatedTime": "string",
    }
  ],
  "TotalCount": 0,
  "Message": "string",
  "StatusCode": 0
}

용어 설명

이 표에서는 응답에 있는 요소의 주요 정의에 대해 설명합니다.

매개 변수 설명
QueryId 쿼리의 고유 UUID
Name 쿼리를 만들 때 쿼리에 지정된 이름
Description 쿼리를 만드는 동안 제공된 설명
Query 보고서 쿼리 문자열
Type 사용자가 만든 쿼리에는 userDefined로, 그리고 미리 정의된 시스템 쿼리에는 system로 설정합니다.
User 쿼리를 만든 사용자 ID
CreatedTime 쿼리 생성 시간
TotalCount 값 배열의 데이터 집합 수
StatusCode 결과 코드입니다. 가능한 값은 200, 400, 401, 403, 500입니다