暫停商業市集報表執行的 API

此 API 可用來暫停報表的排程執行。

要求語法

方法	要求 URI
放	https://api.partnercenter.microsoft.com/insights/v1.1/cmp/ScheduledReport/pause/{ReportID}

要求標頭

頁眉	類型	描述
授權	字串	必填。 格式 Bearer <token> 的 Microsoft Entra 存取令牌
Content-Type	字串	Application/JSON

Path 參數

沒有

查詢參數

參數名稱	必填	類型	描述
reportId	是的	字串	正在修改的報表編號

詞彙

沒有

回應

響應承載的結構如下，採用 JSON 格式：

回應碼：200、400、401、403、404、500 回應承載：

{
  "Value": [
    {
      "ReportId": "string",
      "ReportName": "string",
      "Description": "string",
      "QueryId": "string",
      "Query": "string",
      "User": "string",
      "CreatedTime": "string",
      "ModifiedTime": "string",
      "StartTime": "string",
      "ReportStatus": "string",
      "RecurrenceInterval": 0,
      "RecurrenceCount": 0,
      "CallbackUrl": "string",
      "Format": "string"
    }
  ],
  "TotalCount": 0,
  "Message": "string",
  "StatusCode": 0
}

詞彙

參數	描述
ReportId	您要建立報表的通用唯一識別碼 （UUID）
ReportName	在建立報表時請求有效負載中提供的名稱
Description	在報表建立期間在請求負載中提供的描述
QueryId	在報表建立期間的要求承載中提供的查詢標識碼
Query	將針對此報表執行的查詢文字
User	用來建立報表的使用者標識碼
CreatedTime	UTC 時間以下列格式建立報表：yyyy-MM-ddTHH:mm:ssZ
ModifiedTime	UTC 上次以此格式修改報表的時間：yyyy-MM-ddTHH:mm:ssZ
ExecuteNow	在報表建立過程中提供於請求有效負載中的 ExecuteNow 參數
queryStartTime	在建立報表時，請求內容中提供的查詢開始時間。 只有當 ExecuteNow 設為 「True」 時才適用
queryEndTime	報表建立過程中，在要求的承載內容中提供的查詢結束時間。 只有當 ExecuteNow 設為 「True」 時才適用
StartTime	報表建立請求負載中提供的開始時間
ReportStatus	報表執行的狀態。 可能的值為 Paused、Active和 Inactive。
RecurrenceInterval	在報表建立過程中，請求載荷中提供的重複間隔
RecurrenceCount	報告的剩餘重複次數
CallbackUrl	在創建報表時於請求內容中提供的回呼 URL
CallbackMethod	在建立報表時，於請求負載中提供的回呼方法
Format	報表建立期間在要求承載中提供的報表檔案格式
EndTime	在建立報表時的請求負載中提供的結束時間。 只有當 ExecuteNow 設為 「True」 時才適用
TotalRecurrenceCount	在建立報表的過程中，請求負載中提供的 RecurrenceCount
nextExecutionStartTime	下一次報表執行開始的 UTC 時間戳
TotalCount	Value 陣列中的記錄數目
StatusCode	結果碼。 可能的值為 200、400、401、403、500
message	執行 API 的狀態消息