Pipelines - Get Pipeline Operation

Referensi

Service:: Power BI REST APIs

API Version:: v1.0

Mengembalikan detail operasi penyebaran yang ditentukan yang dilakukan pada alur penyebaran yang ditentukan, termasuk rencana eksekusi penyebaran.

Gunakan untuk melacak status operasi penyebaran.

Cakupan yang Diperlukan

Pipeline.ReadWrite.All atau Pipeline.Read.All

GET https://api.powerbi.com/v1.0/myorg/pipelines/{pipelineId}/operations/{operationId}

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
operationId	path	True	string uuid	ID operasi
pipelineId	path	True	string uuid	ID alur penyebaran

Respons

Nama	Jenis	Deskripsi
200 OK	PipelineOperation	OK

Contoh

Get a pipeline operation example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/pipelines/a5ded933-57b7-41f4-b072-ed4c1f9d5824/operations/1065e6a3-a020-4c0c-ada7-92b5fe99eec5

Sample Response

Status code:: 200

{
  "id": "1065e6a3-a020-4c0c-ada7-92b5fe99eec5",
  "type": "Deploy",
  "status": "Succeeded",
  "lastUpdatedTime": "2020-12-13T09:26:43.153",
  "executionStartTime": "2020-12-13T09:25:43.153Z",
  "executionEndTime": "2020-12-13T09:26:43.153Z",
  "sourceStageOrder": 0,
  "targetStageOrder": 1,
  "executionPlan": {
    "Steps": [
      {
        "index": 0,
        "type": "DataflowDeployment",
        "status": "Succeeded",
        "preDeploymentDiffState": "New",
        "sourceAndTarget": {
          "source": "29efcfb0-0063-44af-a4ed-6c0bee3417d3",
          "sourceDisplayName": "Source dataflow",
          "type": "dataflow"
        }
      },
      {
        "index": 1,
        "type": "DatamartDeployment",
        "status": "Succeeded",
        "preDeploymentDiffState": "New",
        "sourceAndTarget": {
          "source": "645cd81f-1b21-4006-82b6-54cc7ec0352e",
          "sourceDisplayName": "Source datamart",
          "type": "datamart"
        }
      },
      {
        "index": 2,
        "type": "DatasetDeployment",
        "status": "Succeeded",
        "preDeploymentDiffState": "NoDifference",
        "sourceAndTarget": {
          "source": "1a201f2a-d1d8-45c0-8c61-1676338517de",
          "sourceDisplayName": "Source dataset",
          "target": "dd3b6aa1-4d40-405c-a19b-48314a27e8ee",
          "targetDisplayName": "Target dataset",
          "type": "dataset"
        }
      },
      {
        "index": 3,
        "type": "ReportDeployment",
        "status": "Succeeded",
        "preDeploymentDiffState": "Different",
        "sourceAndTarget": {
          "source": "2d225191-65f8-4ec3-b77d-06100602b1f7",
          "sourceDisplayName": "Source report",
          "target": "9d5c1f0f-f85c-48f4-8a8e-4c77547116b3",
          "targetDisplayName": "Target report",
          "type": "report"
        }
      },
      {
        "index": 4,
        "type": "DashboardDeployment",
        "status": "Succeeded",
        "preDeploymentDiffState": "New",
        "sourceAndTarget": {
          "source": "9046e4cc-8aea-4a7a-a3b5-1a78b1447d82",
          "sourceDisplayName": "Source dashboard",
          "type": "dashboard"
        }
      }
    ]
  },
  "note": {
    "content": "Sample note",
    "isTruncated": false
  },
  "preDeploymentDiffInformation": {
    "newArtifactsCount": 3,
    "differentArtifactsCount": 1,
    "noDifferenceArtifactsCount": 1
  },
  "performedBy": {
    "userPrincipalName": "john@contoso.com",
    "principalType": "User"
  }
}

Definisi

Nama	Deskripsi
DeploymentError	Detail kesalahan untuk langkah penyebaran
DeploymentExecutionPlan	Rencana eksekusi penyebaran
DeploymentExecutionStep	Langkah eksekusi penyebaran
DeploymentExecutionStepPreDeploymentDiffState	Adalah item baru, berbeda, atau identik dengan item dalam tahap target sebelum penyebaran.
DeploymentSourceAndTarget	Item sumber dan target
DeploymentStepType	Jenis langkah penyebaran
PipelineOperation	Operasi alur penyebaran Power BI
PipelineOperationNote	Catatan yang menjelaskan penyebaran.
PipelineOperationStatus	Status operasi alur
PipelineOperationType	Jenis operasi
PipelineOperationUser	Pengguna atau perwakilan layanan yang melakukan operasi alur.
PreDeploymentDiffInformation	Jumlah item baru, berbeda, dan identik yang disebarkan sebelum penyebaran.
PrincipalType	Jenis utama

DeploymentError

Detail kesalahan untuk langkah penyebaran

Nama	Jenis	Deskripsi
errorCode	string	Kode kesalahan
errorDetails	string	Detail kesalahan tambahan

DeploymentExecutionPlan

Rencana eksekusi penyebaran

Nama	Jenis	Deskripsi
steps	DeploymentExecutionStep[]	Kumpulan langkah-langkah rencana eksekusi

DeploymentExecutionStep

Langkah eksekusi penyebaran

Nama	Jenis	Deskripsi
error	DeploymentError	Detail kesalahan. Hanya berlaku jika operasi alur gagal.
index	integer	Indeks langkah
preDeploymentDiffState	DeploymentExecutionStepPreDeploymentDiffState	Adalah item baru, berbeda, atau identik dengan item dalam tahap target sebelum penyebaran.
sourceAndTarget	DeploymentSourceAndTarget	Item sumber dan target langkah
status	PipelineOperationStatus	Status operasi alur
type	DeploymentStepType	Jenis langkah penyebaran

DeploymentExecutionStepPreDeploymentDiffState

Adalah item baru, berbeda, atau identik dengan item dalam tahap target sebelum penyebaran.

Nama	Jenis	Deskripsi
Different	string	Sebelum penyebaran, item dalam tahap sumber tidak identik dengan item dalam tahap target.
New	string	Item baru yang disebarkan yang tidak ada di tahap target.
NoDifference	string	Sebelum penyebaran, item dalam tahap sumber identik dengan item dalam tahap target.

DeploymentSourceAndTarget

Item sumber dan target

Nama	Jenis	Deskripsi
source	string	ID item Power BI yang disebarkan dari tahap sumber
sourceDisplayName	string	Nama tampilan item Power BI yang disebarkan dari tahap sumber
target	string	ID item Power BI yang akan ditimpa dalam tahap target. Hanya berlaku saat menimpa item Power BI.
targetDisplayName	string	Nama item Power BI yang akan ditimpa dalam tahap target. Hanya berlaku saat menimpa item Power BI.
type	string	Jenis item Power BI yang akan ditimpa dalam tahap target. Hanya berlaku saat menimpa item Power BI.

DeploymentStepType

Jenis langkah penyebaran

Nama	Jenis	Deskripsi
DashboardDeployment	string	Langkah untuk menyebarkan satu dasbor
DataflowDeployment	string	Langkah untuk menyebarkan satu aliran data
DatamartDeployment	string	Langkah untuk menyebarkan satu datamart
DatasetDeployment	string	Langkah untuk menyebarkan satu himpunan data
ReportDeployment	string	Langkah untuk menyebarkan satu laporan

PipelineOperation

Operasi alur penyebaran Power BI

Nama	Jenis	Deskripsi
executionEndTime	string	Tanggal dan waktu operasi berakhir
executionPlan	DeploymentExecutionPlan	Rencana eksekusi penyebaran. Hanya berlaku untuk satu operasi alur.
executionStartTime	string	Tanggal dan waktu operasi dimulai
id	string	ID operasi
lastUpdatedTime	string	Tanggal dan waktu operasi terakhir diperbarui
note	PipelineOperationNote	Catatan yang mewakili deskripsi operasi.
performedBy	PipelineOperationUser	Pengguna atau perwakilan layanan yang melakukan operasi alur.
preDeploymentDiffInformation	PreDeploymentDiffInformation	Jumlah item yang disebarkan dalam tahap sumber, yang baru, identik, atau berbeda dengan item dalam tahap target, sebelum penyebaran.
sourceStageOrder	integer	Pengidentifikasi numerik dari tahap penyebaran alur sumber. Pengembangan (0), Pengujian (1), Produksi (2).
status	PipelineOperationStatus	Status operasi alur
targetStageOrder	integer	Pengidentifikasi numerik dari tahap penyebaran alur target. Pengembangan (0), Pengujian (1), Produksi (2).
type	PipelineOperationType	Jenis operasi

PipelineOperationNote

Catatan yang menjelaskan penyebaran.

Nama	Jenis	Deskripsi
content	string	Teks yang menjelaskan penyebaran.
isTruncated	boolean	Menunjukkan apakah catatan tidak lengkap. Benar, hanya sebagian catatan yang dikembalikan. False, catatan selesai.

PipelineOperationStatus

Status operasi alur

Nama	Jenis	Deskripsi
Executing	string	Operasi yang dijalankan
Failed	string	Operasi gagal
NotStarted	string	Operasi tidak dimulai
Succeeded	string	Operasi berhasil

PipelineOperationType

Jenis operasi

Nama	Jenis	Deskripsi
Deploy	string	Menyebarkan konten antar tahap

PipelineOperationUser

Pengguna atau perwakilan layanan yang melakukan operasi alur.

Nama	Jenis	Deskripsi
principalObjectID	string	ID perwakilan layanan yang melakukan penyebaran.
principalType	PrincipalType	Jenis pengguna yang melakukan penyebaran.
userPrincipalName	string	UPN pengguna yang melakukan penyebaran.

PreDeploymentDiffInformation

Jumlah item baru, berbeda, dan identik yang disebarkan sebelum penyebaran.

Nama	Jenis	Deskripsi
differentArtifactsCount	integer	Jumlah item yang disebarkan dengan perbedaan antara tahap sumber dan target, sebelum penyebaran.
newArtifactsCount	integer	Jumlah item baru yang disebarkan ke tahap target.
noDifferenceArtifactsCount	integer	Jumlah item yang disebarkan yang identik dalam tahap sumber dan target, sebelum penyebaran.

PrincipalType

Jenis utama

Nama	Jenis	Deskripsi
App	string	Jenis perwakilan layanan
Group	string	Jenis utama grup
None	string	Tidak ada jenis utama. Gunakan untuk seluruh akses tingkat organisasi.
User	string	Jenis prinsipal pengguna

Bagikan melalui