Új kereskedelmi napi besorolású használati v2 API (bétaverzió)
A következőre vonatkozik: Partnerközpont | A 21Vianet által üzemeltetett Partnerközpont | Partnerközpont a Microsoft Cloud for US Government számára
Ezekkel az API-kkal aszinkron módon kérhet le új kereskedelmi számlákat és korlátlan napi névleges használati adatokat.
Feljegyzés
Ez az API elavult lesz. Használja inkább a GA-verziót. További információt az alábbi részletekben talál.
Ezt az API-t csak a 2024. szeptember 30-ig számlázott napi névleges használathoz használhatja. A részletekért válassza ki a megfelelő API-verziót, és tervezze meg előre.
- A lehető leghamarabb lépjen a v2 GA-ra. Addig is használja ezt az API-t a 2022 szeptemberétől kezdődő számlázási időszakokra vonatkozó új kereskedelmi számlák napi névleges használati sorainak lekéréséhez.
- 2024. október 1-től csak az API v2 GA használatával szerezheti be a 2022. szeptemberi számlázási időszakokra vonatkozó új kereskedelmi számlák napi névleges használati sorainak tételeit.
Ezt az API-t csak 2024. szeptember 30-ig használhatja korlátlan napi névleges használathoz. A részletekért válassza ki a megfelelő API-verziót, és tervezze meg előre.
- A lehető leghamarabb lépjen a v2 GA-ra. Addig is használja ezt az API-t, hogy az aktuális és a korábbi számlázási időszakokhoz új, korlátlan napi névleges használati sorelemeket kapjon.
- 2024 . október 1-től csak az API v2 GA használatával szerezhet be új kereskedelmi forgalom nélküli napi névleges használati sorelemeket az aktuális és a korábbi számlázási időszakokhoz.
Az új v2 GA API-k eléréséhez tekintse meg ezt a hivatkozást:
Számlázott és korlátlan napi névleges használati egyeztetési API v2 (GA)
Feljegyzés
A napi nem korlátlan használati sorok elemeit az API-val vagy a Partnerközpont portálján keresztül is lekérheti. Az adatok elérhetővé válása akár 24 órát is igénybe vehet. A tartózkodási helytől és a fogyasztásmérők használati adataitól függően azonban további késések is előfordulhatnak.
Előfordulhat, hogy az előző hónap számlázott használati adatainak kézbesítéséig nem jelenik meg a legutóbbi nem korlátlan használati adatok. Ez annak biztosítása érdekében történik, hogy a számlázott használati adatok a megállapodás szerinti időn belül legyenek kézbesítve. Miután megkapta a számlázott használati adatokat, a hónap elejétől le kell tudnia kérni az összes frissített nembilált használati adatot.
Fontos
A napi névleges használati adatok nem tartalmazzák az alábbi termékek díjait:
- Azure-foglalás
- Azure megtakarítási terv
- Office
- Dynamics
- Microsoft Power Apps
- Állandó szoftver
- Szoftver-előfizetés
- Nem Microsoft SaaS-termék
API – Áttekintés
Az aszinkron API egy új módszer a számlázási és egyeztetési adatok gyors elérésére kezelhető adattömbökben. Így nincs szükség arra, hogy órákon keresztül nyitott kapcsolatot tartson fenn, és több millió tranzakciót iteratív módon végighaladjon.
A valet kulcs és az aszinkron kérés-válasz minták használatával optimalizáltuk a számlázási és egyeztetési API-kat az eredmények aszinkron módon történő továbbításához. Az API-válaszok egy jogkivonatot biztosítanak az egyeztetési adatok eléréséhez az összes attribútummal vagy alkészlettel.
A használati adatokat aszinkron módon három új lépéssel (API-végpontokkal) töltheti le. További információért olvassa el a következőket:
Használati sorelem végpontja
Ezzel az API-val elérheti a számlázott vagy a nem számlázott fogyasztási sorok elemeit. 202 HTTP-állapotot és egy URL-címmel rendelkező helyfejlécet ad vissza, amelyet rendszeres időközönként le kell kérdeznie, amíg a sikeres állapotot nem kapja meg egy jegyzék URL-címmel.
Műveleti állapot végpontja
Amíg meg nem kapja a sikeres állapotot, rendszeresen lekérdezi ezt az API-t. Ha a kért adatok nem érhetők el, az API-válasz tartalmaz egy újrapróbálkozási fejlécet, amely jelzi, hogy mennyi ideig kell várnia egy másik kérés elküldése előtt.
Jegyzékvégpont
Ez a végpont egy tármappát biztosít, amelyből a tényleges számlázási adatok letölthetők. A válasz felosztja vagy particionálta a fájlokat az átviteli sebesség és az I/O párhuzamosság optimalizálása érdekében.
Szekvenciadiagram
Az alábbi ábra az egyeztetési adatok letöltéséhez szükséges lépéseket mutatja be.
Felhasználói műveletütemezés
Az egyeztetési adatok lekéréséhez kövesse az alábbi lépéseket.
1. lépés: Kérelem elküldése
POST-kérés elküldése az API-végpontnak.
Visszavonatlan használati sorok elemeinek lekérése
Lekérheti az aktuális vagy az utolsó naptári hónaphoz tartozó visszavonatlan használati sorelemeket.
API-kérés
POST https://ep-billingreconservice-prod-d5bfczcnfvbqbdhx.z01.azurefd.net/v1/unbilledusage?fragment={fragment}&period={period}?currencyCode={currencyCode}
Kérelemparaméterek
| Név | In | Szükséges | Típus | Leírás |
|---|---|---|---|---|
| Töredék | Lekérdezés | Hamis | Sztring | Válassza a "full" (teljes) lehetőséget a teljes válaszhoz, vagy az attribútumok egy részhalmazának "alapszintű" elemét. Az alapértelmezett érték a "teljes". Tekintse meg a cikkben szereplő attribútumok listáját. |
| Időszak | Lekérdezés | Igaz | Sztring | Használja az "aktuális" vagy az "utolsó" értéket az aktuális vagy az utolsó naptári hónap használatának lekéréséhez. Az "utolsó" érték megegyezik a meglévő V1 API-k "előző" értékével. |
| currencyCode | Lekérdezés | Igaz | Sztring | Partner számlázási pénznemkódja. |
Elavult kérelemparaméterek
Az újabb API-verzióhoz nincs szükség a következő URI-paraméterekre:
| Név | Leírás |
|---|---|
| Szolgáltató | N/A. (Az Összes Azure-csomaghasználatot visszaadja, és egyenértékű a meglévő V1 API-k "egyszeri" használatával.) |
| hasPartnerEarnedCredit | N/A. (a PEC-től függetlenül az összes adatot visszaadja.) |
| Méret | N/A. |
| Eltolás | N/A. |
| seekOperation | N/A. |
Kérelem fejléce
Tekintse meg az API kérésfejléceinek listáját ebben a cikkben.
Kérés törzse
N/A.
API-válasz
HTTP/1.1 202 Accepted Operation-Location: https://ep-billingreconservice-prod-d5bfczcnfvbqbdhx.z01.azurefd.net/v1/billingoperations/811bb8f0-8aca-4807-897c-c15ce50820d6
Az API a 202-es HTTP-állapotot adja vissza. A kérések alapján az API más szabványos állapotot is visszaadhat.
| Név | Leírás |
|---|---|
| 202 Elfogadva | A kérés elfogadva. A kérelem állapotának művelethelyes fejlécének URL-címének lekérdezése. |
Számlázott használati sorok elemeinek lekérése
Lekérheti a számlázott névleges használati sorok elemeit a lezárt számlázási időszakra vonatkozóan.
API-kérés
POST https://ep-billingreconservice-prod-d5bfczcnfvbqbdhx.z01.azurefd.net/v1/billedusage/invoices/{invoiceId}?fragment={fragment}
Kérelemparaméterek
| Név | In | Szükséges | Típus | Leírás |
|---|---|---|---|---|
| invoiceId | Elérési út | Igaz | Sztring | A Partnerközpont számlaszáma. |
| Töredék | Lekérdezés | Hamis | Sztring | Válassza a "full" (teljes) lehetőséget a teljes válaszhoz, vagy az attribútumok egy részhalmazának "alapszintű" elemét. Az alapértelmezett érték a "teljes". Tekintse meg a cikkben szereplő attribútumok listáját. |
Elavult kérelemparaméterek
Az újabb API-verzióhoz nincs szükség a következő URI-paraméterekre:
| Név | Leírás |
|---|---|
| Szolgáltató | N/A. (Az Összes Azure-csomaghasználatot visszaadja, és egyenértékű a meglévő V1 API-k "egyszeri" használatával.) |
| hasPartnerEarnedCredit | N/A. (a PEC-től függetlenül az összes adatot visszaadja.) |
| Méret | N/A. |
| Eltolás | N/A. |
| seekOperation | N/A. |
Kérelem fejléce
Tekintse meg az API kérésfejléceinek listáját ebben a cikkben.
Kérés törzse
N/A.
API-válasz
HTTP/1.1 202 Accepted Operation-Location: https://ep-billingreconservice-prod-d5bfczcnfvbqbdhx.z01.azurefd.net/v1/billingoperations/06d01983-07bf-4448-83b4-1e83ab1d4640
Az API a "HTTP 202 Accepted" értéket adja vissza. A kérelem alapján az API más szabványos állapotot is visszaadhat.
| Név | Leírás |
|---|---|
| 202 Elfogadva | A kérés elfogadva. Ellenőrizze a kérés állapotát a művelet helyének fejlécének URL-címének lekérdezésével. |
2. lépés: A kérelem állapotának ellenőrzése
Várjon egy HTTP 200-as verziót, amelynek terminálállapota sikeres vagy sikertelen. A jegyzék URL-címe "resourceLocation" lesz a sikeres állapotban.
Művelet állapotának lekérése
Lekéri az egyeztetési adatkérés állapotát.
API-kérés
GET https://ep-billingreconservice-prod-d5bfczcnfvbqbdhx.z01.azurefd.net/v1/billingoperations/06d01983-07bf-4448-83b4-1e63ab1d3640
Kérelemparaméterek
| Név | In | Szükséges | Típus | Leírás |
|---|---|---|---|---|
| operationId | Elérési út | Igaz | Sztring | A művelet azonosítója. |
Kérelem fejléce
Tekintse meg az API kérésfejléceinek listáját ebben a cikkben.
Kérés törzse
N/A.
Reagálási állapot
A cikkben szereplő szabványos HTTP-állapot mellett az API a HTTP-állapot alatt is visszaadható:
| Név | Leírás |
|---|---|
| 410 Eltűnt | Minden műveleti hivatkozás aktív egy megadott mennyiségű kiszolgáló által vezérelt ideig. Az idő leteltét követően az ügyfélnek új kérést kell küldenie. |
Válasz hasznos adatai
Az API-válasz hasznos adatai a következő attribútumokat adják vissza:
| Név | Lehetséges | Leírás |
|---|---|---|
| createdDateTime | false | Kérés ideje. |
| lastActionDateTime | false | Állapotváltozás időpontja. |
| resourceLocation | true | A jegyzék hasznos adat URI-ja. |
| status | false | Lehetséges értékek és műveletek. |
| Érték | Ügyfélművelet |
|---|---|
| nincs megadva | Az "Újrapróbálkozás után" fejlécben megadott időpontra való várakozás után egy másik hívással ellenőrizze az állapotot. |
| fut | Az "Újrapróbálkozás után" fejlécben megadott időpontra való várakozás után egy másik hívással ellenőrizze az állapotot. |
| Sikerült | A művelet végső állapota, amely azt jelzi, hogy az adatok készen állnak. Kérje le a jegyzékbeli hasznos adatokat a resourceLocationban megadott URI használatával. |
| sikertelen | Végleges meghibásodást jelző terminálállapot. Indítsa újra a műveletet. |
Hibaattribútum esetén:
| Név | Lehetséges | Leírás |
|---|---|---|
| error | true | Hiba részletei json formátumban, ha a művelet állapota sikertelen. |
| Név | Lehetséges | Leírás |
|---|---|---|
| üzenet | false | Részletesen ismerteti a hibát |
| code | false | Azt jelzi, hogy milyen típusú hiba történt |
API-kérés
GET https://ep-billingreconservice-prod-d5bfczcnfvbqbdhx.z01.azurefd.net/v1/billingoperations/06d01983-07bf-4447-83b4-1e83ab1d3640
API-válasz
A válasz azt javasolja, hogy 10 másodpercig várjon, mielőtt újra próbálkozik az adatok feldolgozásakor.
HTTP/1.1 200 OK
Retry-After: 10
{
"createdDateTime": "2022-06-1T10-01-03.4Z",
"lastActionDateTime":" 2022-06-1T10-01-05Z",
"status": "running"
}
API-kérés
(10 másodperccel a korábbi kérés után)
GET https://ep-billingreconservice-prod-d5bfczcnfvbqbdhx.z01.azurefd.net/v1/billingoperations/06d01983-07bf-4447-83b4-1e83ab1d3640
API-válasz
Az API a "sikeres" állapotot és a "resourceLocation" URI-t adja vissza.
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. lépés: Jegyzék hasznos adatainak lekérése
A hívó get kérést küld a jegyzék URL-címére, hogy többet tudjon meg arról, hol vannak tárolva az egyeztetési adatok az Azure-blobokban.
A jegyzék lekérése
Lekéri az egyeztetési adatok Azure-tárolóhelyével kapcsolatos információkat tartalmazó jegyzékfájlt.
API-kérés
GET https://ep-billingreconservice-prod-d5bfczcnfvbqbdhx.z01.azurefd.net/v1/billingmanifests/{manifestId}
Kérelemparaméterek
| Név | In | Szükséges | Típus | Leírás |
|---|---|---|---|---|
| manifestId | Elérési út | Igaz | Sztring | A jegyzék azonosítója. |
Kérelem fejléce
Ebben a cikkben [az API kérésfejléceinek listáját] tekintheti meg.
Kérés törzse
N/A.
Reagálási állapot
A szabványos HTTP-állapot mellett az API a HTTP-állapot alatt is visszatérhet:
| Név | Leírás |
|---|---|
| 410 Eltűnt | Az egyes jegyzékhivatkozások meghatározott mennyiségű kiszolgáló által vezérelt ideig aktívak. Az idő leteltét követően az ügyfélnek új kérést kell küldenie. |
Válasz hasznos adatai
Az API-válasz a következő attribútumokat adja vissza:
| Név | Leírás |
|---|---|
| Verzió | A jegyzékséma verziója. |
| dataFormat | A számlázási adatfájl formátuma. Lehetséges értékek tömörítettJSONLines: minden blob tömörített fájl, és a fájl adatai JSON-sorok formátumban vannak. Bontsa ki a fájlt az adatok eléréséhez. |
| utcCreatedDateTime | Jegyzékfájl létrehozásának ideje. |
| Etag | Jegyzékadatok verziója. A számlázási adatok módosítása új eTag-értéket hoz létre. |
| partnerTenantId | Partnerbérlom-azonosító. |
| rootFolder | A fájl gyökérkönyvtára. |
| rootFolderSAS | A fájl eléréséhez használt SAS-jogkivonat. |
| partitionType | Ez a tulajdonság osztja el az adatokat. Ha egy adott partíció több mint a támogatott számmal rendelkezik, az adatok a "partitionValue" értéknek megfelelő több fájlra lesznek felosztva. Az adatokat alapértelmezés szerint a fájl sorelemeinek száma particionálta. Ne adjon meg rögzített számú sorelemet vagy fájlméretet a kódban, mert ezek változhatnak. |
| blobCount | A partner bérlőazonosítójának teljes fájlszáma. |
| sizeInBytes | Összes bájt az összes fájlban. |
| blobok | Egy "blob" objektumokat tartalmazó JSON-tömb, amely tartalmazza a partnerbérlelő-azonosító összes fájljának részleteit. |
| Blob objektum | |
| Név | Blob neve. |
| sizeInBytes | Blobméret bájtban. |
| partitionValue | A fájlt tartalmazó partíció. A nagyméretű partíciók több fájlra lesznek felosztva, mindegyik ugyanazzal a "partitionValue"-val. |
Mintajegyzék hasznos adatai
{
"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. lépés: A használat egyeztetési adatainak letöltése a tárolási helyről
Kérje le az SAS-jogkivonatot és a blobtároló helyét a "rootFolderSAS" és a "rootFolder" tulajdonságból, amely a jegyzékbeli hasznos api-választ tartalmazza. Az Azure Storage SDK/eszköz használatával töltse le és bontsa ki a blobfájlt. JSON-sorformátumban van.
Standard API-kérésfejlécek
Minden API elfogadja a következő fejléceket:
| Név | Szükséges | Típus | Leírás |
|---|---|---|---|
| Engedélyezés | Igaz | Sztring | Engedélyezési tulajdonosi jogkivonat. |
| ms-correlationid | Hamis | Sztring | Belső kéréskövető. Minden kérés létrehoz egy új nyomkövetőt (GUID). |
| ms-cv | Hamis | Sztring | Belső kéréskövető. |
| ms-requestid | Hamis | Sztring | A kérelem idempotencia-azonosítója. |
Standard API-válaszállapotok
Az API-válasz HTTP-állapotai a következők:
| Név | Leírás |
|---|---|
| 400 Hibás kérés | Hiányzó vagy helytelen adatok voltak. A hiba részleteit a válasz törzse tartalmazza. |
| 401 Nem engedélyezett | A hívó nincs hitelesítve, és az első hívás megkezdése előtt hitelesítenie kell magát a partner API szolgáltatással. |
| 403 – Tiltott | A hívó nem jogosult a kérés teljesítésére. |
| 500 Belső kiszolgálóhiba | Az API vagy annak egyik függősége nem tudja teljesíteni a kérést. Próbálkozzon újra később. |
| 404 Nem található | Az erőforrás nem érhető el bemeneti paraméterekkel. |
| 410 Eltűnt | A jegyzékhivatkozás túllépte vagy túllépte az időkorlátot. Küldjön be egy új kérést. |
Használati adatattribútumok
A számlázott vagy nem számlázott használati API-válasz a "full" vagy az "basic" kérés paraméterrel a következő attribútumokat adja vissza:
| Attribútum | "teljes" | "alapszintű" |
|---|---|---|
| Partnerazonosító | igen | igen |
| PartnerName | igen | igen |
| Vevőkód | igen | igen |
| CustomerName | igen | Igen |
| CustomerDomainName | igen | nem |
| CustomerCountry | igen | nem |
| MpnId | igen | nem |
| Tier2MpnId | igen | nem |
| InvoiceNumber | igen | igen |
| ProductId | igen | igen |
| Termékváltozat azonosítója | igen | igen |
| Rendelkezésre állási azonosító | igen | nem |
| SkuName | igen | igen |
| ProductName | igen | nem |
| Közzétevő neve | igen | igen |
| PublisherId | igen | nem |
| SubscriptionDescription | igen | nem |
| SubscriptionId | igen | igen |
| ChargeStartDate | igen | igen |
| ChargeEndDate | igen | igen |
| UsageDate | igen | igen |
| MeterType | igen | nem |
| MeterCategory | igen | nem |
| MeterId | igen | nem |
| MeterSubCategory | igen | nem |
| MeterName | igen | nem |
| MeterRegion | igen | nem |
| Unit (Egység) | igen | igen |
| ResourceLocation | igen | nem |
| ConsumedService | igen | nem |
| ResourceGroup | igen | nem |
| ResourceURI | igen | igen |
| ChargeType | igen | igen |
| Egységár | igen | igen |
| Mennyiség | igen | igen |
| UnitType | igen | nem |
| BillingPreTaxTotal | igen | igen |
| BillingCurrency | igen | igen |
| PricingPreTaxTotal | igen | igen |
| PricingCurrency | igen | igen |
| ServiceInfo1 | igen | nem |
| ServiceInfo2 | igen | nem |
| Címkék | igen | nem |
| További információk (Info) | igen | nem |
| EffectiveUnitPrice | igen | igen |
| PCToBCExchangeRate | igen | igen |
| Jogosultságazonosító | igen | igen |
| EntitlementDescription | igen | nem |
| PartnerEarnedCreditPercentage | igen | nem |
| CreditPercentage | igen | igen |
| CreditType | igen | igen |
| BenefitOrderID | igen | igen |
| BenefitID | igen | nem |
| BenefitType | igen | igen |
Visszajelzés
Hamarosan elérhető: 2024-ben fokozatosan kivezetjük a GitHub-problémákat a tartalom visszajelzési mechanizmusaként, és lecseréljük egy új visszajelzési rendszerre. További információ: https://aka.ms/ContentUserFeedback.
Visszajelzés küldése és megtekintése a következőhöz: