Live Events - List Get Status

參考

Service:: Media Services

API Version:: 2022-11-01

取得一個即時活動的狀態
取得即時活動的狀態遙測。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/getStatus?api-version=2022-11-01

URI 參數

名稱	位於	必要	類型	Description
accountName	path	True	string	媒體服務帳戶名稱。
liveEventName	path	True	string	實時活動的名稱，最大長度為32。 Regex pattern: `^[a-zA-Z0-9]+(-[a-zA-Z0-9])$`
resourceGroupName	path	True	string	Azure 訂用帳戶內的資源組名。
subscriptionId	path	True	string	Microsoft Azure 訂用帳戶的唯一標識符。
api-version	query	True	string	要與用戶端要求搭配使用的 API 版本。

回應

名稱	類型	Description
200 OK	LiveEventGetStatusResult	正常。要求成功。
202 Accepted		已接受。已接受處理要求，且作業將會以異步方式完成。如需監視異步 Azure 作業的詳細資訊，請參閱 https://go.microsoft.com/fwlink/?linkid=2087017 。 Headers Location: string Azure-AsyncOperation: string
Other Status Codes		未修改。要求標頭中的 eTag 與記憶體容器中的 eTag 相同。
Other Status Codes	ErrorResponse	串流錯誤回應，描述作業失敗的原因。

範例

Get status of a LiveEvent

POST https://management.azure.com/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveEvents/myLiveEvent1/getStatus?api-version=2022-11-01

/** Samples for LiveEvents ListGetStatus. */
public final class Main {
    /*
     * x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Streaming/stable/2022-11-01/examples/liveevent-get-status.json
     */
    /**
     * Sample code: Get status of a LiveEvent.
     *
     * @param manager Entry point to MediaServicesManager.
     */
    public static void getStatusOfALiveEvent(com.azure.resourcemanager.mediaservices.MediaServicesManager manager) {
        manager
            .liveEvents()
            .listGetStatus("mediaresources", "slitestmedia10", "myLiveEvent1", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "value": [
    {
      "state": "Stopped",
      "healthStatus": "",
      "healthDescriptions": [
        "No issues with ingest."
      ],
      "lastUpdatedTime": "2022-10-19T22:23:05.22Z",
      "ingestion": {
        "streamName": "myStream",
        "begin": "2022-08-17T22:13:59.45Z",
        "end": "2022-08-17T22:20:36.33Z",
        "endReason": "MPE_CLIENT_TERMINATED_SESSION",
        "ingestInterruptions": [
          {
            "begin": "2022-08-17T22:14:32.33Z",
            "end": "2022-08-17T22:15:33.22Z",
            "duration": "PT1S",
            "reason": "MPE_CLIENT_TERMINATED_SESSION"
          }
        ]
      },
      "trackStatus": [
        {
          "trackId": "audio_128000",
          "expectedBitrate": 128000,
          "incomingBitrate": null,
          "ingestDrift": "",
          "requestReceived": null,
          "requestSucceeded": null
        },
        {
          "trackId": "video_2025000",
          "expectedBitrate": 2025000,
          "incomingBitrate": null,
          "ingestDrift": "",
          "requestReceived": null,
          "requestSucceeded": null
        }
      ]
    }
  ]
}

Status code:: 202

azure-asyncoperation: https://management.azure.com/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveeventoperations/62e4d893-d233-4005-988e-a428d9f77076?api-version=2022-11-01
location: https://management.azure.com/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1/operationlocations/62e4d893-d233-4005-988e-a428d9f77076?api-version=2022-11-01

Status code:: 304

定義

名稱	Description
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
LiveEventGetStatusResult	取得即時活動狀態結果。
LiveEventHealthStatus	過去20秒的健康狀態。
LiveEventIngestInterruption	即時活動擷取中斷數據。
LiveEventIngestion	即時活動擷取遙測數據。
LiveEventState	即時活動的目前狀態。如需相關資訊，請參閱 https://go.microsoft.com/fwlink/?linkid=2139012 。
LiveEventStatus	即時活動狀態。
LiveEventTrackStatus	即時活動追蹤狀態。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細資料。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

LiveEventGetStatusResult

取得即時活動狀態結果。

名稱	類型	Description
value	LiveEventStatus[]	取得即時活動狀態的結果。

LiveEventHealthStatus

過去20秒的健康狀態。

名稱	類型	Description
Excellent	string	傳入比特率 = 75% 的目標比特率 >，而且沒有擷取警告和錯誤 AND ABS (IngestDrift) 等於 0。
Good	string	傳入比特率 >= 20% 且沒有擷取錯誤或警告例外狀況不連續，其間距 < 為 10 秒。
Poor	string	否則。

LiveEventIngestInterruption

即時活動擷取中斷數據。

名稱	類型	Description
begin	string	中斷開始的 UTC 時間，編碼器已中斷連線。
duration	string	ISO 8601 時間中斷的持續時間。例如，使用 PT1H30M 來指出 1 小時和 30 分鐘。
end	string	中斷結束的 UTC 時間，編碼器重新連線。
reason	string	中斷原因。

LiveEventIngestion

即時活動擷取遙測數據。

名稱	類型	Description
begin	string	以UTC為單位的擷取開始時間。
end	string	以UTC為單位的擷取結束時間。如果尚未停止，則為空白。
endReason	string	擷取停止的原因。如果尚未停止，則為空白。例如) 服務已停止。無擷取。
ingestInterruptions	LiveEventIngestInterruption[]	IngestInterruption 項目清單。
streamName	string	擷取數據流名稱。

LiveEventState

即時活動的目前狀態。如需相關資訊，請參閱 https://go.microsoft.com/fwlink/?linkid=2139012 。

名稱	類型	Description
Running	string	已配置即時事件資源、已產生擷取和預覽 URL，並且能夠接收即時串流。此時已開始計費。您必須在即時活動資源上明確呼叫「停止」，才能終止進一步計費。
Stopped	string	除非 autostart 設定為 true.) 沒有在此狀態中發生任何計費，否則這是建立 (之後實況活動的初始狀態。在此狀態下，可以更新即時活動屬性，但不允許串流。

LiveEventStatus

即時活動狀態。

名稱	類型	Description
healthDescriptions	string[]	合理化健康狀態的字串清單。
healthStatus	LiveEventHealthStatus	過去20秒的健康狀態。
ingestion	LiveEventIngestion	即時活動擷取專案。
lastUpdatedTime	string	上次更新此狀態的UTC時間。
state	LiveEventState	即時活動的目前狀態。如需相關資訊，請參閱 https://go.microsoft.com/fwlink/?linkid=2139012 。
trackStatus	LiveEventTrackStatus[]	追蹤項目清單。

LiveEventTrackStatus

即時活動追蹤狀態。

名稱	類型	Description
expectedBitrate	integer	此追蹤的預期比特率。
incomingBitrate	integer	即時活動執行時，過去 20 秒的平均傳入比特率。
ingestDrift	string	目前擷取過去 1 分鐘的漂移值，以秒為單位。
requestReceived	integer	已收到的計時元數據要求總數。
requestSucceeded	integer	已收到成功計時元數據要求的總數。
trackId	string	追蹤標識碼。

Share via