Bagikan melalui

Menghentikan peluncuran untuk pengiriman aplikasi

  • Artikel

Gunakan metode ini di API pengiriman Microsoft Store untuk menghentikan peluncuran paket untuk pengiriman aplikasi. Untuk informasi selengkapnya tentang proses pembuatan pengiriman aplikasi dengan menggunakan API pengiriman Microsoft Store, lihat Mengelola pengiriman aplikasi.

Catatan

Jika Anda menghentikan peluncuran untuk pengiriman aplikasi lalu membuat pengiriman aplikasi baru, pengiriman baru adalah klon pengiriman yang dihentikan.

Prasyarat

Untuk menggunakan metode ini, Anda harus terlebih dahulu melakukan hal berikut:

  • Jika Anda belum melakukannya, selesaikan semua prasyarat untuk API pengiriman Microsoft Store.
  • Dapatkan token akses Azure ACTIVE Directory untuk digunakan di header permintaan untuk metode ini. Setelah mendapatkan token akses, Anda memiliki waktu 60 menit untuk menggunakan token akses sebelum masa berlakunya habis. Setelah token kedaluwarsa, Anda dapat memperoleh yang baru.
  • Buat pengiriman untuk salah satu aplikasi Anda. Anda dapat melakukan ini di Pusat Mitra, atau Anda dapat melakukan ini dengan menggunakan metode buat pengiriman aplikasi.
  • Aktifkan peluncuran paket bertahap untuk pengiriman. Anda dapat melakukan ini di Pusat Mitra, atau Anda dapat melakukan ini dengan menggunakan API pengiriman Microsoft Store.

Minta

Metode ini memiliki sintaks berikut. Lihat bagian berikut untuk contoh penggunaan dan deskripsi parameter header dan permintaan.

Metode URI Permintaan
POST https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/haltpackagerollout

Header permintaan

Header Tipe Deskripsi
Authorization string Harus diisi. Token akses Microsoft Azure ACTIVE Directory dalam bentuk token> Pembawa<.

Parameter permintaan

Nama Tipe Deskripsi
applicationId string Harus diisi. ID Toko aplikasi yang berisi pengiriman dengan peluncuran paket yang ingin Anda hentikan. Untuk informasi selengkapnya tentang ID Penyimpanan, lihat Menampilkan detail identitas aplikasi.
submissionId string Harus diisi. ID pengiriman dengan peluncuran paket yang ingin Anda hentikan. ID ini tersedia dalam data respons untuk permintaan membuat pengiriman aplikasi. Untuk pengiriman yang dibuat di Pusat Mitra, ID ini juga tersedia di URL untuk halaman pengiriman di Pusat Mitra.

Isi permintaan

Jangan berikan isi permintaan untuk metode ini.

Contoh permintaan

Contoh berikut menunjukkan cara menghentikan peluncuran paket untuk pengiriman aplikasi.

POST https://manage.devcenter.microsoft.com/v1.0/my/applications/9NBLGGH4R315/submissions/1152921504621243680/haltpackagerollout HTTP/1.1
Authorization: Bearer <your access token>

Respons

Contoh berikut menunjukkan isi respons JSON untuk panggilan yang berhasil ke metode ini. Untuk detail selengkapnya tentang nilai dalam isi respons, lihat Sumber daya peluncuran paket.

{
    "isPackageRollout": true,
    "packageRolloutPercentage": 0.0,
    "packageRolloutStatus": "PackageRolloutStopped",
    "fallbackSubmissionId": "1212922684621243058"
}

Kode kesalahan

Jika permintaan tidak berhasil diselesaikan, respons akan berisi salah satu kode kesalahan HTTP berikut.

Kode kesalahan Deskripsi
404 Pengiriman tidak dapat ditemukan.
409 Kode ini menunjukkan salah satu kesalahan berikut:

  • Pengiriman tidak dalam status valid untuk operasi peluncuran bertahap (sebelum memanggil metode ini, pengiriman harus diterbitkan dan nilai packageRolloutStatus harus diatur ke PackageRolloutInProgress).
  • Pengiriman bukan milik aplikasi yang ditentukan.
  • Aplikasi ini menggunakan fitur Pusat Mitra yang saat ini tidak didukung oleh API pengiriman Microsoft Store.