Funkce rozhraní REST API
Následující funkce podporují entity Microsoft Azure Media Services prováděním různých úloh, jako je rušení úloh, načítání klíčů ochrany atd.
CancelJob
. Přebírá následující parametr: jobid typu Edm.String
.
GetProtectionKeyId
. Přebírá následující parametr: contentKeyType typu Edm.Int32
. Vrací objekt Edm.String
.
GetProtectionKey
. Přebírá následující parametr: protectionKeyId typu Edm.String
. Vrací objekt Edm.String
.
CreateFileInfos
. Přebírá následující parametr: assetid typu Edm.String
.
RebindContentKey
. Přebírá následující parametry: id typu Edm.String
, x509Certificate typu Edm.String
. Vrací objekt Edm.String
.
Publish
. Přebírá následující parametr: assetid typu Microsoft.Cloud.Media.Vod.Rest.Data.Models.Asset
.
GetKeyDeliveryUrl
. Přebírá následující parametry: contentKey typu Microsoft.Cloud.Media.Vod.Rest.Data.Models.ContentKey
, keyDeliveryTypeEdm.String
typu. Vrací objekt Edm.Int32
.
Start
. Přebírá následující parametr: streamingEndpointMicrosoft.Cloud.Media.Vod.Rest.Data.Models.StreamingEndpoint
typu.
Start
. Přebírá následující parametr: kanál typu Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel
.
Start
. Přebírá následující parametr: program typu Microsoft.Cloud.Media.Vod.Rest.Data.Models.Program
.
Stop
. Přebírá následující parametr: streamingEndpointMicrosoft.Cloud.Media.Vod.Rest.Data.Models.StreamingEndpoint
typu.
Stop
. Přebírá následující parametr: kanál typu Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel
.
Stop
. Přebírá následující parametr: program typu Microsoft.Cloud.Media.Vod.Rest.Data.Models.Program
.
Scale
. Přebírá následující parametry: streamingEndpoint typu Microsoft.Cloud.Media.Vod.Rest.Data.Models.StreamingEndpoint
, scaleUnits typu Edm.String
.
ShowSlate
. Přebírá následující parametry: kanál typu Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel
, doba trváníEdm.Time
typu, assetId typu Edm.String
.
StartAdvertisement
. Přebírá následující parametry: kanál typu Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel
, doba trváníEdm.Time
typu, cueId typu Edm.Int32
, showSlate typu Edm.Boolean
.
HideSlate
. Přebírá následující parametr: kanál typu Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel
.
EndAdvertisement
. Přebírá následující parametry: kanál typu Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel
, cueId typu Edm.Int32
.
Reset
. Přebírá následující parametr: kanál typu Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel
.
Důležité
Při přístupu k entitě ve službě Media Services musíte v požadavcích HTTP nastavit konkrétní pole hlaviček a hodnoty.
Další informace najdete v tématu Nastavení pro vývoj rozhraní REST API služby Media Services a připojení ke službě Media Services pomocí rozhraní REST API služby Media Services.
Zbývající část tématu ukazuje několik příkladů, jak volat funkce pomocí REST.
Zrušit úlohu
Spuštěné úlohy lze zrušit voláním úlohy CancelJob a předáním ID úlohy aktuálně spuštěné úlohy.
Metoda | Identifikátor URI žádosti | Verze PROTOKOLU HTTP |
---|---|---|
GET | <https:// accountname.restv2>.<location.media.azure.net/api/CancelJob?jobid>='URL-encodedvalue' | HTTP/1.1 |
Ukázkový požadavek
Nejnovější verzi najdete v x-ms-version:
tématu Rest služby Media Services.
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
Entita File se vytvoří pomocí funkce CreateFileInfos a předá ID prostředku přidruženého k multimediálnímu souboru, který jste nahráli do úložiště objektů blob. Další informace najdete v tématu Nahrání souboru do úložiště objektů blob.
Metoda | Identifikátor URI žádosti | Verze PROTOKOLU HTTP |
---|---|---|
GET | <https:// accountname.restv2>.<location.media.azure.net/api/CreateFileInfos?assetid>='URL-encodedvalue' | HTTP/1.1 |
Ukázkový požadavek
Nejnovější verzi najdete v x-ms-version:
tématu Rest služby Media Services.
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
Funkce GetProtectionKeyId načte kryptografický otisk certifikátu X.509, který se používá k zajištění, že máte na počítači nainstalovaný správný certifikát při šifrování klíče obsahu definovaného uživatelem. Seznam možných hodnot parametru contentKeyType mapuje na hodnoty výčtu ContentKeyType v entitě ContentKey. Další informace najdete v tématu Vlastnosti entity ContentKey.
Metoda | Identifikátor URI žádosti | Verze PROTOKOLU HTTP |
---|---|---|
GET | <https:// accountname.restv2>.<location.media.azure.net/api/GetProtectionKeyId?contentKeyType>=value | HTTP/1.1 |
Ukázkový požadavek
Nejnovější verzi najdete v x-ms-version:
tématu Rest služby Media Services.
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 načte konkrétní certifikát X.509, který by se měl použít k šifrování klíče obsahu definovaného uživatelem.
Metoda | Identifikátor URI žádosti | Verze PROTOKOLU HTTP |
---|---|---|
GET | <https:// accountname.restv2>.<location.media.azure.net/api/GetProtectionKey?ProtectionKeyId>='value' | HTTP/1.1 |
Ukázkový požadavek
Nejnovější verzi najdete v x-ms-version:
tématu Rest služby Media Services.
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
Pokud chcete načíst šifrovaný klíč obsahu zpět ze služby Media Services, zavolejte RebindContentKey a předejte id contentkey a certifikát X.509 (pouze s veřejným klíčem), který byl použit k šifrování šifrování úložiště nebo klíče obsahu běžné ochrany. Pokud zavoláte RebindContentKey a předáte prázdný řetězec do parametru x509Certificate, pak je klíč obsahu zakódovaný jako base64 a vrátí se v clear.
Metoda | Identifikátor URI žádosti | Verze PROTOKOLU HTTP |
---|---|---|
GET | <https:// accountname.restv2>.<location.media.azure.net/api/RebindContentKey?id>='contentkeyid'&x509Certificate='URL-encodedvalue' | HTTP/1.1 |
Ukázkový požadavek
Nejnovější verzi najdete v x-ms-version:
tématu Rest služby Media Services.
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