Műveletek lekérése
Cikk 06/14/2024
2 közreműködő
Visszajelzés
A cikk tartalma
Feljegyzés
A Cloud Partner Portal API-k integrálva vannak a Partnerközpontban, és továbbra is működni fognak. Az áttűnés kis változásokat vezet be. Tekintse át a Cloud Partner Portal API-referenciájában felsorolt módosításokat, hogy a kód továbbra is működjön a Partnerközpontra való áttérés után. A CPP API-kat csak olyan meglévő termékekhez szabad használni, amelyek már integrálva voltak a Partnerközpontra való áttérés előtt; az új termékeknek a Partnerközpont beküldési API-jait kell használniuk.
Lekéri az ajánlat összes műveletét, vagy lekéri a megadott műveletazonosítóhoz tartozó adott műveletet. Az ügyfél lekérdezési paraméterekkel szűrhet a futó műveletekre.
GET https://cloudpartner.azure.com/api/publishers/<publisherId>/offers/<offerId>/operations/<operationId>?api-version=2017-10-31
URI-paraméterek
Név
Leírás
Adattípus
publisherId
Közzétevő azonosítója, például Contoso
Sztring
offerId
Ajánlat azonosítója
Sztring
operationId
GUID, amely egyedileg azonosítja az ajánlaton lévő műveletet. Előfordulhat, hogy a műveletazonosító ezzel az API-val kérhető le, és a válasz HTTP-fejlécében is megjelenik minden hosszú ideig futó művelethez, például a Publish offer API-hoz.
GUID
api-verzió
Az API legújabb verziója
Dátum
Név
Érték
Content-Type
application/json
Engedélyezés
Bearer YOUR_TOKEN
Példa törzsre
Válasz
GET-műveletek
[
{
"id": "5a63deb5-925b-4ee0-938b-7c86fbf287c5",
"offerId": "56615b67-2185-49fe-80d2-c4ddf77bb2e8",
"offerVersion": 1,
"offerTypeId": "microsoft-azure-virtualmachines",
"publisherId": "contoso",
"submissionType": "publish",
"submissionState": "running",
"publishingVersion": 2,
"slot": "staging",
"version": 636576975611768314,
"definition": {
"metadata": {
"emails": "jdoe@contoso.com"
}
},
"changedTime": "2018-03-26T21:46:01.179948Z"
}
]
GET művelet
[
{
"status" : "running",
"messages" : [],
"publishingVersion" : 2,
"offerVersion" : 1,
"cancellationRequestState": "canCancel",
"steps": [
{
"estimatedTimeFrame": "< 15 min",
"id": "displaydummycertify",
"stepName": "Validate Pre-Requisites",
"description": "Offer settings provided are validated",
"status": "complete",
"messages":
[
{
"messageHtml": "Step completed.",
"level": "information",
"timestamp": "2017-03-28T19:50:36.500052Z"
}
],
"progressPercentage": 100
},
{
"estimatedTimeFrame": "< 5 day",
"id": "displaycertify",
"stepName": "Certification",
"description": "Your offer is analyzed by our certification systems for issues.",
"status": "blocked",
"messages":
[
{
"messageHtml": "No virtual machine image was found for the plan contoso.",
"level": "error",
"timestamp": "2017-03-28T19:50:39.5506018Z"
},
{
"messageHtml": "This step has not started yet.",
"level": "information",
"timestamp": "2017-03-28T19:50:39.5506018Z"
}
],
"progressPercentage": 0
},
{
"estimatedTimeFrame": "< 1 day",
"id": "displayprovision",
"stepName": "Provisioning",
"description": "Your virtual machine is being replicated in our production systems.",
"status": "notStarted",
"messages": [],
"progressPercentage": 0
},
{
"estimatedTimeFrame": "< 1 hour",
"id": "displaypackage",
"stepName": "Packaging and Lead Generation Registration",
"description": "Your virtual machine is packaged for being shown to your customers. Additionally, we hookup our lead generation systems to send leads for your offer.",
"status": "notStarted",
"messages": [],
"progressPercentage": 0
},
{
"id": "publisher-signoff",
"stepName": "Publisher signoff",
"description": "Offer is available to preview. Ensure that everything looks good before making your offer live.",
"status": "notStarted",
"messages": [],
"progressPercentage": 0
},
{
"estimatedTimeFrame": "~2-5 days",
"id": "live",
"stepName": "Live",
"description": "Offer is publicly visible and is available for purchase.",
"status": "notStarted",
"messages": [],
"progressPercentage": 0
}
],
"previewLinks": [],
"liveLinks": [],
}
}
]
Választörzs tulajdonságai
Név
Leírás
id
A műveletet egyedileg azonosító GUID
submissionType
Azonosítja az ajánlathoz jelentett művelet típusát, például Publish/GoLive
createdDateTime
UTC dátumidő a művelet létrehozásakor
lastActionDateTime
UTC dátumidő, amikor az utolsó frissítés történt a műveleten
status
A művelet állapota vagy not started
failed
| completed
running
| | . Egyszerre csak egy művelet lehet állapotú running
.
error
Sikertelen műveletek hibaüzenete
Válaszlépés tulajdonságai
Név
Leírás
estimatedTimeFrame
A művelet becsült időtartama
id
A lépésfolyamat egyedi azonosítója
leírás
A lépés leírása
stepName
A lépés rövid neve
status
A lépés állapota vagy notStarted
| running
| failed
| completed
üzenet
A lépés során észlelt értesítések vagy figyelmeztetések. Sztringek tömbje
progressPercentage
0 és 100 közötti egész szám, amely a lépés előrehaladását jelzi
Válaszállapot-kódok
Kód
Leírás
200
OK
- A kérés feldolgozása sikeresen megtörtént, és a kért művelet(ek) vissza lettek adva.
400
Bad/Malformed request
– A hibaválasz törzse további információkat tartalmazhat.
403
Forbidden
- Az ügyfél nem rendelkezik hozzáféréssel a megadott névtérhez.
404
Not found
- A megadott entitás nem létezik.