Pobieranie operacji
Artykuł 06/14/2024
Współautorzy: 2
Opinia
W tym artykule
Uwaga
Interfejsy API portalu Cloud Partner Portal są zintegrowane z usługą i będą nadal działać w Centrum partnerskim. Przejście wprowadza niewielkie zmiany. Przejrzyj zmiany wymienione w dokumentacji interfejsu API portalu Cloud Partner Portal, aby upewnić się, że kod będzie nadal działać po przejściu do Centrum partnerskiego. Interfejsy API CPP powinny być używane tylko dla istniejących produktów, które zostały już zintegrowane przed przejściem do Centrum partnerskiego; nowe produkty powinny używać interfejsów API przesyłania w Centrum partnerskim.
Pobiera wszystkie operacje w ofercie lub, aby uzyskać określoną operację dla określonego identyfikatora operationId. Klient może używać parametrów zapytania do filtrowania uruchomionych operacji.
GET https://cloudpartner.azure.com/api/publishers/<publisherId>/offers/<offerId>/operations/<operationId>?api-version=2017-10-31
Parametry identyfikatora URI
Nazwa/nazwisko Opis Typ danych
publisherId
Identyfikator wydawcy, na przykład Contoso
String
offerId
Identyfikator oferty
String
operationId
Identyfikator GUID, który jednoznacznie identyfikuje operację w ofercie. Identyfikator operationId można pobrać przy użyciu tego interfejsu API i jest również zwracany w nagłówku HTTP odpowiedzi dla dowolnej długotrwałej operacji, takiej jak interfejs API oferty Publikowania.
Identyfikator GUID
api-version
Najnowsza wersja interfejsu API
Data
Nazwa/nazwisko Wartość
Typ zawartości
application/json
Autoryzacja
Bearer YOUR_TOKEN
Przykład treści
Response
Operacje GET
[
{
"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"
}
]
Operacja GET
[
{
"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": [],
}
}
]
Właściwości treści odpowiedzi
Nazwa/nazwisko Opis
identyfikator
Identyfikator GUID, który jednoznacznie identyfikuje operację
submissionType
Określa typ operacji zgłaszanej dla oferty, na przykład Publish/GoLive
createdDateTime
Data/godzina UTC utworzenia operacji
lastActionDateTime
Data/godzina UTC wykonania ostatniej aktualizacji operacji
status
Stan operacji: not startedfailed | completedrunning | | . Tylko jedna operacja może mieć stan running naraz.
error
Komunikat o błędzie dotyczący operacji, które zakończyły się niepowodzeniem
Właściwości kroku odpowiedzi
Nazwa/nazwisko Opis
estimatedTimeFrame
Szacowany czas trwania tej operacji
identyfikator
Unikatowy identyfikator procesu kroku
opis
Opis kroku
stepName
Przyjazna nazwa kroku
status
Stan kroku, albo notStarted | running | failed | completed
wiadomości
Wszystkie powiadomienia lub ostrzeżenia napotkane podczas kroku. Tablica ciągów
progressPercentage
Liczba całkowita z zakresu od 0 do 100 wskazująca postęp kroku
Kody stanu odpowiedzi
Kod Opis
200
OK — Żądanie zostało pomyślnie przetworzone, a żądane operacje zostały zwrócone.
400
Bad/Malformed request — Treść odpowiedzi na błąd może zawierać więcej informacji.
403
Forbidden — Klient nie ma dostępu do określonej przestrzeni nazw.
404
Not found - Określona jednostka nie istnieje.