Funkcje interfejsu API REST
Poniższe funkcje obsługują jednostki Microsoft Azure Media Services, wykonując różne zadania, takie jak anulowanie zadań, pobieranie kluczy ochrony itd.
CancelJob. Przyjmuje następujący parametr: jobid typu Edm.String .
GetProtectionKeyId. Przyjmuje następujący parametr: contentKeyTypeEdm.Int32 typu. Zwraca wartość Edm.String.
GetProtectionKey. Przyjmuje następujący parametr: protectionKeyId typu Edm.String . Zwraca wartość Edm.String.
CreateFileInfos. Przyjmuje następujący parametr: assetidEdm.String typu.
RebindContentKey. Przyjmuje następujące parametry: identyfikatorEdm.String typu x509CertificateEdm.String typu. Zwraca wartość Edm.String.
Publish. Przyjmuje następujący parametr: assetidMicrosoft.Cloud.Media.Vod.Rest.Data.Models.Asset typu.
GetKeyDeliveryUrl. Przyjmuje następujące parametry: contentKeyMicrosoft.Cloud.Media.Vod.Rest.Data.Models.ContentKey typu keyDeliveryType typu Edm.String . Zwraca wartość Edm.Int32.
Start. Przyjmuje następujący parametr: streamingEndpoint typu Microsoft.Cloud.Media.Vod.Rest.Data.Models.StreamingEndpoint .
Start. Przyjmuje następujący parametr: kanałMicrosoft.Cloud.Media.Vod.Rest.Data.Models.Channel typu.
Start. Przyjmuje następujący parametr: program typu Microsoft.Cloud.Media.Vod.Rest.Data.Models.Program .
Stop. Przyjmuje następujący parametr: streamingEndpoint typu Microsoft.Cloud.Media.Vod.Rest.Data.Models.StreamingEndpoint .
Stop. Przyjmuje następujący parametr: kanałMicrosoft.Cloud.Media.Vod.Rest.Data.Models.Channel typu.
Stop. Przyjmuje następujący parametr: program typu Microsoft.Cloud.Media.Vod.Rest.Data.Models.Program .
Scale. Przyjmuje następujące parametry: streamingEndpoint typu Microsoft.Cloud.Media.Vod.Rest.Data.Models.StreamingEndpointscaleUnits typu Edm.String .
ShowSlate. Przyjmuje następujące parametry: kanałMicrosoft.Cloud.Media.Vod.Rest.Data.Models.Channel typu, czas trwaniaEdm.Time typu, identyfikator zasobuEdm.String typu.
StartAdvertisement. Przyjmuje następujące parametry: kanałMicrosoft.Cloud.Media.Vod.Rest.Data.Models.Channel typu, czas trwaniaEdm.Time typu, cueIdEdm.Int32 typu, showSlate typu Edm.Boolean .
HideSlate. Przyjmuje następujący parametr: kanałMicrosoft.Cloud.Media.Vod.Rest.Data.Models.Channel typu.
EndAdvertisement. Przyjmuje następujące parametry: kanałMicrosoft.Cloud.Media.Vod.Rest.Data.Models.Channel typu, cueIdEdm.Int32 typu.
Reset. Przyjmuje następujący parametr: kanałMicrosoft.Cloud.Media.Vod.Rest.Data.Models.Channel typu.
Ważne
Podczas uzyskiwania dostępu do jednostek w usłudze Media Services należy ustawić określone pola nagłówka i wartości w żądaniach HTTP.
Aby uzyskać więcej informacji, zobacz Konfigurowanie tworzenia interfejsu API REST usługi Media Services i nawiązywanie połączenia z usługą Media Services przy użyciu interfejsu API REST usługi Media Services.
W pozostałej części tematu przedstawiono kilka przykładów wywoływania funkcji przy użyciu interfejsu REST.
CancelJob
Uruchomione zadania można anulować, wywołując polecenie CancelJob i przekazując identyfikator zadania aktualnie uruchomionego zadania.
| Metoda | Identyfikator URI żądania | Wersja protokołu HTTP |
|---|---|---|
| GET | <https:// accountname.restv2>.<location.media.azure.net/api/CancelJob?jobid>='URL-encodedvalue' | HTTP/1.1 |
Przykładowe żądanie
Aby uzyskać najnowszą wersję x-ms-version:, zobacz 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
Jednostka File jest tworzona przy użyciu funkcji CreateFileInfos i przekazuje identyfikator zasobu skojarzony z plikiem multimedialnym przekazanym do magazynu obiektów blob. Aby uzyskać więcej informacji, zobacz Przekazywanie pliku do magazynu obiektów blob.
| Metoda | Identyfikator URI żądania | Wersja protokołu HTTP |
|---|---|---|
| GET | <https:// accountname.restv2>.<location.media.azure.net/api/CreateFileInfos?assetid>='URL-encodedvalue' | HTTP/1.1 |
Przykładowe żądanie
Aby uzyskać najnowszą wersję x-ms-version:, zobacz 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
Funkcja GetProtectionKeyId pobiera odcisk palca certyfikatu X.509, który służy do zapewnienia, że na maszynie jest zainstalowany prawidłowy certyfikat podczas szyfrowania klucza zawartości zdefiniowanego przez użytkownika. Lista możliwych wartości dla mapowania parametru contentKeyType na wartości wyliczenia ContentKeyType w jednostce ContentKey. Aby uzyskać więcej informacji, zobacz ContentKey Entity Properties (Właściwości jednostki ContentKey).
| Metoda | Identyfikator URI żądania | Wersja protokołu HTTP |
|---|---|---|
| GET | <https:// accountname.restv2>.<location.media.azure.net/api/GetProtectionKeyId?contentKeyType>=value | HTTP/1.1 |
Przykładowe żądanie
Aby uzyskać najnowszą wersję x-ms-version:, zobacz 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 pobiera określony certyfikat X.509, który powinien służyć do szyfrowania klucza zawartości zdefiniowanego przez użytkownika.
| Metoda | Identyfikator URI żądania | Wersja protokołu HTTP |
|---|---|---|
| GET | <https:// accountname.restv2>.<location.media.azure.net/api/GetProtectionKey?ProtectionKeyId>='value' | HTTP/1.1 |
Przykładowe żądanie
Aby uzyskać najnowszą wersję x-ms-version:, zobacz 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
Jeśli chcesz pobrać zaszyfrowany klucz zawartości z powrotem z usługi Media Services, wywołaj metodę RebindContentKey i przekaż identyfikator ContentKey i certyfikat X.509 (tylko klucz publiczny), który został użyty do szyfrowania kluczy zawartości szyfrowania magazynu wyczyść/common protection. Jeśli wywołasz parametr RebindContentKey i przekażesz pusty ciąg do parametru x509Certificate, klucz zawartości jest zakodowany w formacie base64 i zwrócony w postaci wyczyszczonej.
| Metoda | Identyfikator URI żądania | Wersja protokołu HTTP |
|---|---|---|
| GET | <https:// accountname.restv2>.<location.media.azure.net/api/RebindContentKey?id>='contentkeyid'&x509Certificate='URL-encodedvalue' | HTTP/1.1 |
Przykładowe żądanie
Aby uzyskać najnowszą wersję x-ms-version:, zobacz 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