Dela via


Hämta åtgärder

Not

API:erna för Molnpartnerportalen är integrerade med och fortsätter att fungera i Partnercenter. Övergången introducerar små ändringar. Granska ändringarna i API-referens för Cloud Partner Portal för att se till att koden fortsätter att fungera efter övergången till Partnercenter. CPP-API:er bör endast användas för befintliga produkter som redan var integrerade före övergången till Partnercenter. nya produkter ska använda API:er för insändning av Partnercenter.

Hämtar alla åtgärder i erbjudandet eller för att hämta en viss åtgärd för angivet operationId. Klienten kan använda frågeparametrar för att filtrera på åtgärder som körs.

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

URI-parametrar

namn Beskrivning Datatyp
publisherId Utgivaridentifierare, till exempel Contoso Sträng
offerId Erbjudandeidentifierare Sträng
operationId GUID som unikt identifierar åtgärden i erbjudandet. OperationId kan hämtas med hjälp av det här API:et och returneras också i HTTP-huvudet för svaret för alla tidskrävande åtgärder, till exempel Publicera erbjudande API. GUID
api-version Senaste versionen av API:et Datum
namn Värde
Innehållstyp application/json
Tillstånd Bearer YOUR_TOKEN

Brödtextexempel

Svar

GET-åtgärder

    [
        {
            "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-åtgärd

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

Egenskaper för svarstext

namn Beskrivning
Id GUID som unikt identifierar åtgärden
submissionType Identifierar vilken typ av åtgärd som rapporteras för erbjudandet, till exempel Publish/GoLive
createdDateTime UTC datetime när åtgärden skapades
lastActionDateTime UTC datetime när den senaste uppdateringen gjordes för åtgärden
status Status för åtgärden, antingen not started | running | failed | completed. Endast en åtgärd kan ha status running i taget.
fel Felmeddelande för misslyckade åtgärder

Egenskaper för svarssteg

namn Beskrivning
estimatedTimeFrame Den uppskattade varaktigheten för den här åtgärden
Id Den unika identifieraren för stegprocessen
beskrivning Beskrivning av steget
stepName Det egna namnet för steget
status Status för steget, antingen notStarted | running | failed | completed
Meddelanden Meddelanden eller varningar som påträffas under steget. Matris med strängar
progressPercentage Ett heltal från 0 till 100 som anger stegets förlopp

Svarsstatuskoder

Code Beskrivning
200 OK – Begäran har bearbetats och de begärda åtgärderna returnerades.
400 Bad/Malformed request – Felsvarstexten kan innehålla mer information.
403 Forbidden – Klienten har inte åtkomst till det angivna namnområdet.
404 Not found – Den angivna entiteten finns inte.