REST API-functies
De volgende functies ondersteunen de Microsoft Azure Media Services entiteiten door verschillende taken uit te voeren, zoals het annuleren van taken, het ophalen van beveiligingssleutels, enzovoort.
CancelJob
. Neemt de volgende parameter: jobid van het Edm.String
type.
GetProtectionKeyId
. Gebruikt de volgende parameter: contentKeyType van het Edm.Int32
type. Retourneert Edm.String
.
GetProtectionKey
. Gebruikt de volgende parameter: protectionKeyId van het Edm.String
type. Retourneert Edm.String
.
CreateFileInfos
. Gebruikt de volgende parameter: assetid van het Edm.String
type.
RebindContentKey
. Gebruikt de volgende parameters: id van Edm.String
het type, x509Certificaat van Edm.String
het type. Retourneert Edm.String
.
Publish
. Gebruikt de volgende parameter: assetid van het Microsoft.Cloud.Media.Vod.Rest.Data.Models.Asset
type.
GetKeyDeliveryUrl
. Gebruikt de volgende parameters: contentKey van Microsoft.Cloud.Media.Vod.Rest.Data.Models.ContentKey
het type, keyDeliveryType van het Edm.String
type. Retourneert Edm.Int32
.
Start
. Gebruikt de volgende parameter: streamingEndpoint van het Microsoft.Cloud.Media.Vod.Rest.Data.Models.StreamingEndpoint
type.
Start
. Gebruikt de volgende parameter: kanaal van Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel
het type.
Start
. Gebruikt de volgende parameter: programma van het Microsoft.Cloud.Media.Vod.Rest.Data.Models.Program
type.
Stop
. Gebruikt de volgende parameter: streamingEndpoint van het Microsoft.Cloud.Media.Vod.Rest.Data.Models.StreamingEndpoint
type.
Stop
. Gebruikt de volgende parameter: kanaal van Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel
het type.
Stop
. Gebruikt de volgende parameter: programma van het Microsoft.Cloud.Media.Vod.Rest.Data.Models.Program
type.
Scale
. Gebruikt de volgende parameters: streamingEindpunt van het Microsoft.Cloud.Media.Vod.Rest.Data.Models.StreamingEndpoint
type, scaleUnits van het Edm.String
type.
ShowSlate
. Gebruikt de volgende parameters: kanaal van Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel
type, duur van Edm.Time
type, assetId van Edm.String
type.
StartAdvertisement
. Gebruikt de volgende parameters: kanaal van Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel
het type, duur van Edm.Time
type, cueId van Edm.Int32
type, showSlate van Edm.Boolean
type.
HideSlate
. Gebruikt de volgende parameter: kanaal van Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel
het type.
EndAdvertisement
. Gebruikt de volgende parameters: kanaal van Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel
het type, cueId van het Edm.Int32
type.
Reset
. Gebruikt de volgende parameter: kanaal van Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel
het type.
Belangrijk
Bij het openen van entiteiten in Media Services moet u specifieke headervelden en -waarden instellen in uw HTTP-aanvragen.
Zie Setup for Media Services REST API Development and Connecting to Media Services with the Media Services REST API (Verbinding maken met Media Services met de Media Services REST API) voor meer informatie.
In de rest van het onderwerp ziet u enkele voorbeelden van het aanroepen van functies met behulp van REST.
CancelJob
Actieve taken kunnen worden geannuleerd door CancelJob aan te roepen en de taak-id door te geven van een taak die momenteel wordt uitgevoerd.
Methode | Aanvraag-URI | HTTP-versie |
---|---|---|
GET | <https:// accountnaam.restv2>.<location.media.azure.net/api/CancelJob?jobid>='URL-encodedvalue' | HTTP/1.1 |
Voorbeeldaanvraag
Zie Media Services REST voor de meest recente x-ms-version:
versie.
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
Er wordt een bestandsentiteit gemaakt met behulp van de functie CreateFileInfos en de asset-id doorgegeven die is gekoppeld aan het mediabestand dat u hebt geüpload naar blobopslag. Zie Een bestand uploaden naar blobopslag voor meer informatie.
Methode | Aanvraag-URI | HTTP-versie |
---|---|---|
GET | <https:// accountnaam.restv2>.<location.media.azure.net/api/CreateFileInfos?assetid>='URL-encodedvalue' | HTTP/1.1 |
Voorbeeldaanvraag
Zie Media Services REST voor de meest recente x-ms-version:
versie.
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
De functie GetProtectionKeyId haalt een X.509-certificaatvingerafdruk op die wordt gebruikt om ervoor te zorgen dat u het juiste certificaat op uw computer hebt geïnstalleerd bij het versleutelen van uw door de gebruiker gedefinieerde inhoudssleutel. De lijst met mogelijke waarden voor de parameter contentKeyType wordt toegewezen aan de opsommingswaarden van ContentKeyType op de entiteit ContentKey. Zie Eigenschappen van ContentKey-entiteit voor meer informatie.
Methode | Aanvraag-URI | HTTP-versie |
---|---|---|
GET | <https:// accountnaam.restv2>.<location.media.azure.net/api/GetProtectionKeyId?contentKeyType>=value | HTTP/1.1 |
Voorbeeldaanvraag
Zie Media Services REST voor de meest recente x-ms-version:
versie.
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 haalt het specifieke X.509-certificaat op dat moet worden gebruikt om uw door de gebruiker gedefinieerde inhoudssleutel te versleutelen.
Methode | Aanvraag-URI | HTTP-versie |
---|---|---|
GET | <https:// accountnaam.restv2>.<location.media.azure.net/api/GetProtectionKey?ProtectionKeyId>='value' | HTTP/1.1 |
Voorbeeldaanvraag
Zie Media Services REST voor de meest recente x-ms-version:
versie.
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
Als u uw versleutelde inhoudssleutel terug wilt halen uit Media Services, roept u RebindContentKey aan en geeft u uw ContentKey-id en het X.509-certificaat (met alleen de openbare sleutel) door dat is gebruikt voor het versleutelen van de inhoudssleutels voor clear storage-/algemene beveiliging. Als u RebindContentKey aanroept en een lege tekenreeks doorgeeft aan de parameter x509Certificate, wordt uw inhoudssleutel met base64 gecodeerd en duidelijk geretourneerd.
Methode | Aanvraag-URI | HTTP-versie |
---|---|---|
GET | <https:// accountnaam.restv2>.<location.media.azure.net/api/RebindContentKey?id>='contentkeyid'&x509Certificate='URL-encodedvalue' | HTTP/1.1 |
Voorbeeldaanvraag
Zie Media Services REST voor de meest recente x-ms-version:
versie.
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