Funktionen der REST-API
Die folgenden Funktionen unterstützen die Microsoft Azure Media Services Entitäten, indem verschiedene Aufgaben ausgeführt werden, z. B. das Abbrechen von Aufträgen, das Abrufen von Schutzschlüsseln usw.
CancelJob. Verwendet den folgenden Parameter: jobid vom Edm.String Typ.
GetProtectionKeyId. Verwendet den folgenden Parameter: contentKeyType vom Edm.Int32 Typ. Gibt Edm.String zurück.
GetProtectionKey. Nimmt den folgenden Parameter an: protectionKeyId vom Edm.String Typ. Gibt Edm.String zurück.
CreateFileInfos. Verwendet den folgenden Parameter: assetid vom Edm.String Typ.
RebindContentKey. Verwendet die folgenden Parameter: id vom Edm.String Typ , x509Certificate vom Edm.String Typ. Gibt Edm.String zurück.
Publish. Verwendet den folgenden Parameter: assetid vom Microsoft.Cloud.Media.Vod.Rest.Data.Models.Asset Typ.
GetKeyDeliveryUrl. Verwendet die folgenden Parameter: contentKey vom Microsoft.Cloud.Media.Vod.Rest.Data.Models.ContentKey Typ, keyDeliveryType vom Edm.String Typ. Gibt Edm.Int32 zurück.
Start. Verwendet den folgenden Parameter: streamingEndpoint vom Microsoft.Cloud.Media.Vod.Rest.Data.Models.StreamingEndpoint Typ.
Start. Verwendet den folgenden Parameter: Kanal vom Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel Typ.
Start. Verwendet den folgenden Parameter: Programm vom Microsoft.Cloud.Media.Vod.Rest.Data.Models.Program Typ.
Stop. Verwendet den folgenden Parameter: streamingEndpoint vom Microsoft.Cloud.Media.Vod.Rest.Data.Models.StreamingEndpoint Typ.
Stop. Verwendet den folgenden Parameter: Kanal vom Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel Typ.
Stop. Verwendet den folgenden Parameter: Programm vom Microsoft.Cloud.Media.Vod.Rest.Data.Models.Program Typ.
Scale. Verwendet die folgenden Parameter: streamingEndpoint vom Microsoft.Cloud.Media.Vod.Rest.Data.Models.StreamingEndpoint Typ, scaleUnits vom Edm.String Typ.
ShowSlate. Übernimmt die folgenden Parameter: Kanal vom Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel Typ, Dauer des Typs Edm.Time , assetId des Typs Edm.String .
StartAdvertisement. Übernimmt die folgenden Parameter: Kanal vom Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel Typ, Dauer des Typs Edm.Time , cueId vom Edm.Int32 Typ, showSlate des Typs Edm.Boolean .
HideSlate. Verwendet den folgenden Parameter: Kanal vom Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel Typ.
EndAdvertisement. Übernimmt die folgenden Parameter: Kanal vom Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel Typ, cueId vom Edm.Int32 Typ.
Reset. Verwendet den folgenden Parameter: Kanal vom Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel Typ.
Wichtig
Wenn Sie in Media Services auf Entitäten zugreifen, müssen Sie bestimmte Headerfelder und Werte in Ihren HTTP-Anforderungen festlegen.
Weitere Informationen finden Sie unter Einrichten der Media Services-REST-API-Entwicklung und Herstellen einer Verbindung mit Media Services mit der Media Services-REST-API.
Der Rest des Themas zeigt einige Beispiele für das Aufrufen von Funktionen mithilfe von REST.
CancelJob
Aktuell ausgeführte Aufträge können durch Aufrufen von CancelJob und Übergeben der Auftrags-ID eines aktuell ausgeführten Auftrags abgebrochen werden.
| Methode | Anforderungs-URI | HTTP-Version |
|---|---|---|
| GET | <https:// accountname.restv2>.<location.media.azure.net/api/CancelJob?jobid>='URL-encodedvalue' | HTTP/1.1 |
Beispiel für eine Anforderung
Informationen zum Aktuellen x-ms-version:finden Sie unter Media Services REST.
GET https://<accountname>.restv2.<location>.media.azure.net/api/CancelJob?jobid='nb%3ajid%3aUUID%3a9e9533ba-2b9b-fa4c-a33d-73eebd49039b' HTTP/1.1
Content-Type: application/json;odata=verbose
Accept: application/json;odata=verbose
DataServiceVersion: 3.0
MaxDataServiceVersion: 3.0
x-ms-version: 2.19
Authorization: Bearer <token value>
Host: media.windows.net
CreateFileInfos
Eine File-Entität wird mithilfe der Funktion CreateFileInfos und Übergeben der Medienobjekt-ID erstellt, die der Mediendatei zugeordnet ist, die Sie in den Blob-Speicher hochgeladen haben. Weitere Informationen finden Sie unter Hochladen einer Datei in den Blob-Speicher.
| Methode | Anforderungs-URI | HTTP-Version |
|---|---|---|
| GET | <https:// accountname.restv2>.<location.media.azure.net/api/CreateFileInfos?assetid>='URL-encodedvalue' | HTTP/1.1 |
Beispiel für eine Anforderung
Informationen zum Aktuellen x-ms-version:finden Sie unter Media Services REST.
GET https://<accountname>.restv2.<location>.media.azure.net/api/CreateFileInfos?assetid='nb%3Acid%3AUUID%3Ac80d312d-7cb1-44aa-bb23-2c35d10c44bd' HTTP/1.1
Content-Type: application/json;odata=verbose
Accept: application/json;odata=verbose
DataServiceVersion: 3.0
MaxDataServiceVersion: 3.0
x-ms-version: 2.19
Authorization: Bearer <token value>
Host: media.windows.net
Content-Length: 0
GetProtectionKeyId
Die Funktion GetProtectionKeyId ruft den Fingerabdruck eines X.509-Zertifikats ab, der zum Sicherstellen verwendet wird, dass das richtige Zertifikat auf Ihrem Computer installiert ist, wenn Ihr benutzerdefinierter Inhaltsschlüssel verschlüsselt wird. Die Liste der möglichen Werte für den Parameter contentKeyType sind den ContentKeyType-Enumerationswerten der ContentKey-Entität zugeordnet. Weitere Informationen finden Sie unter ContentKey-Entitätseigenschaften.
| Methode | Anforderungs-URI | HTTP-Version |
|---|---|---|
| GET | <https:// accountname.restv2>.<location.media.azure.net/api/GetProtectionKeyId?contentKeyType>=value | HTTP/1.1 |
Beispiel für eine Anforderung
Informationen zum Aktuellen x-ms-version:finden Sie unter Media Services REST.
GET https://<accountname>.restv2.<location>.media.azure.net/api/GetProtectionKeyId?contentKeyType=1 HTTP/1.1
Content-Type: application/json;odata=verbose
Accept: application/json;odata=verbose
DataServiceVersion: 3.0
MaxDataServiceVersion: 3.0
x-ms-version: 2.19
Authorization: Bearer <token value>
Host: media.windows.net
GetProtectionKey
GetProtectionKey ruft das jeweilige X.509-Zertifikat ab, das zum Verschlüsseln Ihres benutzerdefinierten Inhaltsschlüssels verwendet werden soll.
| Methode | Anforderungs-URI | HTTP-Version |
|---|---|---|
| GET | <https:// accountname.restv2>.<location.media.azure.net/api/GetProtectionKey?ProtectionKeyId>='value' | HTTP/1.1 |
Beispiel für eine Anforderung
Informationen zum Aktuellen x-ms-version:finden Sie unter Media Services REST.
GET https://<accountname>.restv2.<location>.media.azure.net/api/GetProtectionKey?ProtectionKeyId='B2FE17BEF56FFCB9A3FC4267D0F2AFE25CD2DE22' HTTP/1.1
Content-Type: application/json;odata=verbose
Accept: application/json;odata=verbose
DataServiceVersion: 3.0
MaxDataServiceVersion: 3.0
x-ms-version: 2.19
Authorization: Bearer <token value>
Host: media.windows.net
RebindContentKey
Wenn Sie Ihren verschlüsselten Inhaltsschlüssel von Media Services abrufen möchten, rufen Sie RebindContentKey auf, und übergeben Sie Ihre ContentKey-ID und das X.509-Zertifikat (nur mit dem öffentlichen Schlüssel), das zum Verschlüsseln der eindeutigen Speicherverschlüsselung/allgemeinen Inhaltsschlüssel verwendet wurde. Wenn Sie RebindContentKey aufrufen und eine leere Zeichenfolge an den Parameter x509Certificate übergeben, wird Ihr Inhaltsschlüssel base64-codiert und unverschlüsselt zurückgegeben.
| Methode | Anforderungs-URI | HTTP-Version |
|---|---|---|
| GET | <https:// accountname.restv2>.<location.media.azure.net/api/RebindContentKey?id>='contentkeyid'&x509Certificate='URL-encodedvalue' | HTTP/1.1 |
Beispiel für eine Anforderung
Informationen zum Aktuellen x-ms-version:finden Sie unter Media Services REST.
GET https://<accountname>.restv2.<location>.media.azure.net/api/RebindContentKey?id='nb%3akid%3aUUID%3a2eeba14e-613e-4af7-a926-413372cca8d5'&x509Certificate='' HTTP/1.1
Content-Type: application/json;odata=verbose
Accept: application/json;odata=verbose
DataServiceVersion: 3.0
MaxDataServiceVersion: 3.0
x-ms-version: 2.19
Authorization: Bearer <token value>
Host: media.windows.net