İşlemleri alma

Makale
06/14/2024

Not

Bulut İş Ortağı Portalı API'leri ile tümleşiktir ve İş Ortağı Merkezi'nde çalışmaya devam edecektir. Geçiş küçük değişiklikler sağlar. İş Ortağı Merkezi'ne geçtikten sonra kodunuzun çalışmaya devam ettiğinden emin olmak için Bulut İş Ortağı Portalı API Başvurusu'nda listelenen değişiklikleri gözden geçirin. CPP API'leri yalnızca İş Ortağı Merkezi'ne geçiş öncesinde zaten tümleştirilmiş olan mevcut ürünler için kullanılmalıdır; yeni ürünler İş Ortağı Merkezi gönderim API'lerini kullanmalıdır.

Teklif üzerindeki tüm işlemleri alır veya belirtilen operationId için belirli bir işlemi alır. İstemci, çalışan işlemleri filtrelemek için sorgu parametrelerini kullanabilir.

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

URI parametreleri

Ad	Açıklama	Veri türü
publisherId	Yayımcı tanımlayıcısı, örneğin `Contoso`	String
offerId	Teklif tanımlayıcısı	String
operationId	Teklifte işlemi benzersiz olarak tanımlayan GUID. operationId değeri bu API kullanılarak alınabilir ve teklifi yayımlama API'si gibi uzun süre çalışan işlemler için yanıtın HTTP üst bilgisinde de döndürülür.	GUID
api-sürümü	API'nin en son sürümü	Tarih

Ad	Value
İçerik Türü	`application/json`
Yetkilendirme	`Bearer YOUR_TOKEN`

Gövde örneği

Response

GET işlemleri

    [
        {
            "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 işlemi

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

Yanıt gövdesi özellikleri

Ad	Açıklama
id	İşlemi benzersiz olarak tanımlayan GUID
submissionType	Teklif için bildirilen işlem türünü tanımlar, örneğin `Publish/GoLive`
createdDateTime	İşlemin oluşturulduğu UTC tarih saat
lastActionDateTime	İşlemde son güncelleştirmenin yapıldığı UTC tarih saat
durum	İşlemin durumu veya `not startedfailed` \| `completedrunning` \| \| . Aynı anda yalnızca bir işlemin durumu `running` olabilir.
error	Başarısız işlemler için hata iletisi

Yanıt adımı özellikleri

Ad	Açıklama
tahminiTimeFrame	Bu işlemin tahmini süresi
id	Adım işleminin benzersiz tanımlayıcısı
açıklama	Adımın açıklaması
stepName	Adımın kolay adı
durum	Adımın durumu `notStarted` \| `running` \| `failed` \| `completed`
iletiler	Adım sırasında karşılaşılan tüm bildirimler veya uyarılar. Dizeler dizisi
progressPercentage	Adımın ilerleme durumunu gösteren 0 ile 100 arasından bir tamsayı

Yanıt durum kodları

Kod	Açıklama
200	`OK` - İstek başarıyla işlendi ve istenen işlemler döndürüldü.
400	`Bad/Malformed request` - Hata yanıtı gövdesi daha fazla bilgi içerebilir.
Kategori 403	`Forbidden` - İstemcinin belirtilen ad alanına erişimi yok.
404	`Not found` - Belirtilen varlık yok.

Aracılığıyla paylaş