새 상거래 일별 등급 사용량 v2 API(베타)

적용 대상: 파트너 센터 | 21Vianet에서 운영되는 파트너 센터 | Microsoft Cloud for US Government 파트너 센터

이러한 API를 사용하여 새 상거래 요금 청구 및 청구되지 않은 일일 등급 사용량 현황 데이터를 비동기적으로 가져옵니다.

API 개요

비동기 API는 관리 가능한 청크에서 청구 및 조정 데이터에 빠르게 액세스하는 새로운 방법입니다. 몇 시간 동안 열린 연결을 유지하고 수백만 개의 트랜잭션을 반복적으로 반복할 필요가 없습니다.

발렛 키 및 비동기 요청-회신 패턴을 사용하여 호출 및 조정 API를 최적화하여 결과를 비동기적으로 전달합니다. API 응답은 모든 특성 또는 하위 집합을 사용하여 조정 데이터에 액세스하는 토큰을 제공합니다.

세 가지 새로운 단계(API 엔드포인트)를 사용하여 사용량 현황 데이터를 비동기적으로 다운로드할 수 있습니다. 자세한 내용은 다음 섹션을 참조하세요.

사용량 줄 항목 엔드포인트

이 API를 사용하여 청구되거나 청구되지 않은 소비 품목에 액세스합니다. 202 HTTP 상태와 URL이 있는 위치 헤더를 반환하며, 매니페스트 URL을 사용하여 성공 상태를 받을 때까지 정기적으로 폴링해야 합니다.

작업 상태 엔드포인트

성공 상태가 나타날 때까지 이 API를 정기적으로 폴링합니다. 요청된 데이터를 사용할 수 없는 경우 API 응답에는 다른 요청을 보내기 전에 대기해야 하는 시간을 나타내는 Retry-After 헤더가 포함됩니다.

매니페스트 엔드포인트

이 엔드포인트는 실제 청구 데이터를 다운로드할 수 있는 스토리지 폴더를 제공합니다. 응답은 파일을 분할하거나 분할하여 처리량 및 I/O 병렬 처리를 최적화합니다.

시퀀스 다이어그램

이 다이어그램은 조정 데이터를 다운로드하는 데 필요한 단계를 보여 줍니다.

사용자 작업 순서

조정 데이터를 검색하려면 다음 단계를 수행합니다.

1단계: 요청 제출

API 엔드포인트에 POST 요청을 제출합니다.

청구되지 않은 사용 현황 품목 가져오기

현재 또는 지난 달의 청구되지 않은 사용 현황 품목을 가져옵니다.

API 요청

POST https://ep-billingreconservice-prod-d5bfczcnfvbqbdhx.z01.azurefd.net/v1/unbilledusage?fragment={fragment}&period={period}?currencyCode={currencyCode}

요청 매개 변수

사용되지 않는 요청 매개 변수

최신 API 버전에는 다음 URI 매개 변수가 필요하지 않습니다.

요청 헤더

이 문서의 API 에 대한 요청 헤더 목록을 참조하세요.

요청 본문

해당 없음.

API 응답

HTTP/1.1 202 Accepted Operation-Location: https://ep-billingreconservice-prod-d5bfczcnfvbqbdhx.z01.azurefd.net/v1/billingoperations/811bb8f0-8aca-4807-897c-c15ce50820d6

API는 HTTP 상태 202를 반환합니다. 요청에 따라 API는 다른 표준 상태를 반환할 수 있습니다.

청구된 사용량 품목 가져오기

닫힌 청구 기간에 대한 청구 등급 사용량 품목을 가져옵니다.

API 요청

POST https://ep-billingreconservice-prod-d5bfczcnfvbqbdhx.z01.azurefd.net/v1/billedusage/invoices/{invoiceId}?fragment={fragment}

요청 매개 변수

사용되지 않는 요청 매개 변수

최신 API 버전에는 다음 URI 매개 변수가 필요하지 않습니다.

요청 헤더

이 문서의 API 에 대한 요청 헤더 목록을 참조하세요.

요청 본문

해당 없음.

API 응답

HTTP/1.1 202 Accepted Operation-Location: https://ep-billingreconservice-prod-d5bfczcnfvbqbdhx.z01.azurefd.net/v1/billingoperations/06d01983-07bf-4448-83b4-1e83ab1d4640

API는 "HTTP 202 수락됨"을 반환합니다. 요청 API에 따라 다른 표준 상태를 반환할 수 있습니다.

2단계: 요청 상태 확인

터미널 상태가 성공 또는 실패인 HTTP 200을 기다립니다. 매니페스트 URL은 성공 상태의 "resourceLocation"입니다.

작업 상태 가져오기

조정 데이터 요청의 상태를 가져옵니다.

API 요청

GET https://ep-billingreconservice-prod-d5bfczcnfvbqbdhx.z01.azurefd.net/v1/billingoperations/06d01983-07bf-4448-83b4-1e63ab1d3640

요청 매개 변수

요청 헤더

이 문서의 API 에 대한 요청 헤더 목록을 참조하세요.

요청 본문

해당 없음.

응답 상태

이 문서의 표준 HTTP 상태 외에도 API는 다음 HTTP 상태를 반환할 수 있습니다.

응답 페이로드

API 응답 페이로드는 다음 특성을 반환합니다.

오류 특성의 경우:

API 요청

GET https://ep-billingreconservice-prod-d5bfczcnfvbqbdhx.z01.azurefd.net/v1/billingoperations/06d01983-07bf-4447-83b4-1e83ab1d3640

API 응답

응답은 데이터를 처리할 때 다시 시도하기 전에 10초 동안 대기하는 것을 제안합니다.

HTTP/1.1 200 OK  
Retry-After: 10  
{  
"createdDateTime": "2022-06-1T10-01-03.4Z",  
"lastActionDateTime":" 2022-06-1T10-01-05Z",  
"status": "running"  
}

API 요청

(이전 요청 후 10초)

GET https://ep-billingreconservice-prod-d5bfczcnfvbqbdhx.z01.azurefd.net/v1/billingoperations/06d01983-07bf-4447-83b4-1e83ab1d3640

API 응답

API는 "성공" 상태와 "resourceLocation" URI를 반환합니다.

HTTP/1.1 200 OK  
Content-Type: application/json  
{  
"createdDateTime": "2022-06-1T10-01-03.4Z",  
"lastActionDateTime": "2022-06-1T10-01-13Z",  
"status": "succeeded",  
"resourceLocation": "https://ep-billingreconservice-prod-d5bfczcnfvbqbdhx.z01.azurefd.net/v1/billingmanifests/e03e1882-ff59-4c09-882f-74e60b4d7743"  
}

3단계: 매니페스트 페이로드 가져오기

호출자는 조정 데이터가 Azure Blob에 저장되는 위치에 대해 자세히 알아보기 위해 매니페스트 URL에 GET 요청을 합니다.

매니페스트 가져오기

조정 데이터의 Azure 스토리지 위치에 대한 정보가 있는 매니페스트를 검색합니다.

API 요청

GET https://ep-billingreconservice-prod-d5bfczcnfvbqbdhx.z01.azurefd.net/v1/billingmanifests/{manifestId}

요청 매개 변수

요청 헤더

이 문서의 [API에 대한 요청 헤더 목록]을 참조하세요.

요청 본문

해당 없음.

응답 상태

표준 HTTP 상태 외에도 API는 다음 HTTP 상태를 반환할 수 있습니다.

응답 페이로드

API 응답은 다음 특성을 반환합니다.

샘플 매니페스트 페이로드

{
"version": "1",
"dataFormat": "compressedJSONLines",
"utcCretedDateTime": "2022-04-29T22:40:57.1853571Z",
"eTag": "0x5B168C7B6E589D2",
"partnerTenantId": "14f593ad-1edc-474d-aaa0-83abbf9638da",
"rootFolder": "https://{billing.blob.core.windows.net}/{folder_path}",
"rootFolderSAS": "\*\*\*",
"partitionType": "ItemCount",
"blobCount": 3,
"sizeInBytes": 2000,
"blobs": [
  {
  "name": "{blobName1.json.gz}",
  "sizeinBytes": 500,
  "partitionValue": "1"
  },
  {
  "name": "{blobName2.json.gz}",
  "sizeinBytes": 1000,
  "partitionValue": "2"
  },
  {
  "name": "{blobName3.json.gz}",
  "sizeinBytes": 500,
  "partitionValue": "3"
  }
  ]
}

4단계: 스토리지 위치에서 사용량 조정 데이터 다운로드

"rootFolderSAS" 및 "rootFolder"에서 SAS 토큰 및 Blob Storage 위치를 가져오면 매니페스트 페이로드 API 응답이 속성됩니다. Azure Storage SDK/도구를 사용하여 Blob 파일을 다운로드하고 압축을 풉니다. JSON 줄 형식입니다.

표준 API 요청 헤더

모든 API는 다음 헤더를 허용합니다.

표준 API 응답 상태

API 응답의 HTTP 상태는 다음과 같습니다.

사용량 현황 데이터 특성

"full" 또는 "basic" 요청 매개 변수가 있는 청구되거나 청구되지 않은 사용량 API 응답은 다음 특성을 반환합니다.