Bagikan melalui

Ambil operasi

  • Artikel

Catatan

API Portal Mitra Cloud terintegrasi dengan dan akan terus bekerja di Pusat Mitra. Transisi memperkenalkan perubahan kecil. Tinjau perubahan yang tercantum di Referensi API Portal Mitra Cloud untuk memastikan kode Anda terus berfungsi setelah transisi ke Pusat Mitra. API CPP hanya boleh digunakan untuk produk yang sudah terintegrasi sebelum transisi ke Pusat Mitra. Produk baru harus menggunakan API pengiriman Pusat Mitra.

Mengambil semua operasi yang ditawarkan atau untuk mendapatkan operasi tertentu untuk operationId yang ditentukan. Klien dapat menggunakan parameter kueri untuk memfilter operasi yang sedang berjalan.

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

Parameter URI

Nama Keterangan Jenis data
publisherId Pengidentifikasi penerbit, misalnya Contoso String
offerId Pengidentifikasi penawaran String
operationId GUID yang secara unik mengidentifikasi operasi yang ditawarkan. operationId mungkin diambil dengan menggunakan API ini, dan juga dikembalikan di header HTTP respons untuk operasi yang berjalan lama, seperti Terbitkan API penawaran . Guid
versi-api Versi terbaru API Tanggal
Nama Nilai
Content-Type application/json
Authorization Bearer YOUR_TOKEN

Contoh isi

Respons

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

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

Properti isi respons

Nama Keterangan
id GUID yang secara unik mengidentifikasi operasi
jenis pengiriman Mengidentifikasi jenis operasi yang dilaporkan untuk penawaran, misalnya Publish/GoLive
createdDateTime Tanggalwaktu UTC saat operasi dibuat
lastActionDateTime Tanggalwaktu UTC ketika pembaruan terakhir dilakukan pada operasi
status Status operasi, baik not startedfailed | completedrunning | | . Hanya satu operasi yang dapat memiliki status running pada satu waktu.
kesalahan Pesan kesalahan untuk operasi yang gagal

Properti langkah respons

Nama Keterangan
estimatedTimeFrame Perkiraan durasi operasi ini
id Pengidentifikasi unik untuk proses langkah
description Deskripsi langkah
stepName Nama yang ramah untuk langkahnya
status Status langkah, baik notStarted | running | failed | completed
pesan Pemberitahuan atau peringatan apa pun yang ditemui selama langkah tersebut. Array string
progressPercentage Bilangan bulat dari 0 hingga 100 menunjukkan perkembangan langkah

Kode status respons

Kode Keterangan
200 OK - Permintaan berhasil diproses dan operasi yang diminta dikembalikan.
400 Bad/Malformed request - Isi respons kesalahan mungkin berisi lebih banyak informasi.
403 Forbidden - Klien tidak memiliki akses ke namespace yang ditentukan.
404 Not found - Entitas yang ditentukan tidak ada.