Sdílet prostřednictvím

Načtení operací

  • Článek

Poznámka:

Rozhraní API portálu partnerů cloudu jsou integrovaná a budou pokračovat v práci v Partnerském centru. Přechod zavádí malé změny. Projděte si změny uvedené v referenčních informacích k rozhraní API portálu partnerů cloudu a ujistěte se, že váš kód po přechodu do Partnerského centra bude fungovat i nadále. Rozhraní API CPP by se měla používat pouze pro stávající produkty, které už byly integrované před přechodem do Partnerského centra; nové produkty by měly používat rozhraní API pro odesílání v Partnerském centru.

Načte všechny operace v nabídce nebo k získání konkrétní operace pro zadané ID operace. Klient může k filtrování spuštěných operací použít parametry dotazu.

GET https://cloudpartner.azure.com/api/publishers/<publisherId>/offers/<offerId>/operations/<operationId>?api-version=2017-10-31

Parametry identifikátoru URI

Název Popis Datový typ
publisherId Například identifikátor vydavatele Contoso String
offerId Identifikátor nabídky String
operationId Identifikátor GUID, který jednoznačně identifikuje operaci v nabídce. Id operace se může načíst pomocí tohoto rozhraní API a vrátí se také v hlavičce HTTP odpovědi pro všechny dlouhotrvající operace, jako je například rozhraní API nabídky publikování. Guid
verze-api Nejnovější verze rozhraní API Datum
Název Hodnota
Typ obsahu application/json
Autorizace Bearer YOUR_TOKEN

Základní příklad

Response

Operace 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"
        }
    ]

Operace 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": [],
            }
        }
    ]

Vlastnosti textu odpovědi

Název Popis
ID IDENTIFIKÁTOR GUID, který jednoznačně identifikuje operaci
submissionType Určuje typ operace hlášené pro nabídku, například Publish/GoLive
createdDateTime Datum a čas UTC při vytvoření operace
lastActionDateTime Datum a čas UTC, kdy byla poslední aktualizace provedena v operaci
stav Stav operace, a to buď not startedcompleted | | running | failed. Stav může mít running najednou jenom jedna operace.
chyba Chybová zpráva pro neúspěšné operace

Vlastnosti kroku odpovědi

Název Popis
estimatedTimeFrame Odhadovaná doba trvání této operace
ID Jedinečný identifikátor kroku
description Popis kroku
stepName Popisný název kroku
stav Stav kroku, a to buď notStarted | running | failed | completed
zprávy Všechna oznámení nebo upozornění, ke kterým došlo během kroku. Pole řetězců
progressPercentage Celé číslo od 0 do 100 označující průběh kroku

Stavové kódy odpovědí

Kód Popis
200 OK – Žádost byla úspěšně zpracována a byly vráceny požadované operace.
400 Bad/Malformed request – Text odpovědi na chybu může obsahovat další informace.
403 Forbidden – Klient nemá přístup k zadanému oboru názvů.
404 Not found – Zadaná entita neexistuje.