Поделиться через

Функции REST API

  • Статья

Следующие функции поддерживают Cлужбы мультимедиа Microsoft Azure сущностей, выполняя различные задачи, такие как отмена заданий, получение ключей защиты и т. д.

CancelJob. Принимает следующий параметр: jobid типа Edm.String .

GetProtectionKeyId. Принимает следующий параметр: contentKeyType типа Edm.Int32 . Возвращает Edm.String.

GetProtectionKey. Принимает следующий параметр: protectionKeyId типа Edm.String . Возвращает Edm.String.

CreateFileInfos. Принимает следующий параметр: assetid типа Edm.String .

RebindContentKey. Принимает следующие параметры: idEdm.String типа, x509Certificate типа Edm.String . Возвращает Edm.String.

Publish. Принимает следующий параметр: assetid типа Microsoft.Cloud.Media.Vod.Rest.Data.Models.Asset .

GetKeyDeliveryUrl. Принимает следующие параметры: contentKey типа Microsoft.Cloud.Media.Vod.Rest.Data.Models.ContentKey , keyDeliveryTypeEdm.String типа. Возвращает Edm.Int32.

Start. Принимает следующий параметр: streamingEndpoint типа Microsoft.Cloud.Media.Vod.Rest.Data.Models.StreamingEndpoint .

Start. Принимает следующий параметр: канал типа Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel .

Start. Принимает следующий параметр: program с типом Microsoft.Cloud.Media.Vod.Rest.Data.Models.Program .

Stop. Принимает следующий параметр: streamingEndpoint типа Microsoft.Cloud.Media.Vod.Rest.Data.Models.StreamingEndpoint .

Stop. Принимает следующий параметр: канал типа Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel .

Stop. Принимает следующий параметр: program с типом Microsoft.Cloud.Media.Vod.Rest.Data.Models.Program .

Scale. Принимает следующие параметры: streamingEndpoint типа Microsoft.Cloud.Media.Vod.Rest.Data.Models.StreamingEndpoint , scaleUnitsEdm.String типа.

ShowSlate. Принимает следующие параметры: канал типа Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel , длительность типа Edm.Time , assetIdEdm.String типа.

StartAdvertisement. Принимает следующие параметры: канал типа Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel , длительностьEdm.Time типа, cueIdEdm.Int32 типа, showSlate типа Edm.Boolean .

HideSlate. Принимает следующий параметр: канал типа Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel .

EndAdvertisement. Принимает следующие параметры: канал типа Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel , cueId типа Edm.Int32 .

Reset. Принимает следующий параметр: канал типа Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel .

Важно!

При доступе к сущностям в службах мультимедиа необходимо задать определенные поля и значения заголовков в HTTP-запросах.
Дополнительные сведения см. в разделе Настройка разработки REST API Служб мультимедиа и подключение к службам мультимедиа с помощью REST API Служб мультимедиа.

В оставшейся части раздела приведено несколько примеров вызова функций с помощью REST.

CancelJob

Работу заданий можно отменить вызовом CancelJob и передачей идентификатора текущего работающего задания.

Метод Универсальный код ресурса (URI) запроса Версия HTTP
GET <https:// accountname.restv2>.<location.media.azure.net/api/CancelJob?jobid>='URL-encodedvalue' HTTP/1.1

Пример запроса

Сведения о том, как получить последнюю версию x-ms-version:, см. в разделе 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

Сущность «Файл» создается с помощью функции CreateFileInfos и передачи в идентификатор ресурса, который связан с файлом мультимедиа, переданным в хранилище больших двоичных объектов. Дополнительные сведения см. в разделе Передача файла в хранилище больших двоичных объектов.

Метод Универсальный код ресурса (URI) запроса Версия HTTP
GET <https:// accountname.restv2>.<location.media.azure.net/api/CreateFileInfos?assetid>='URL-encodedvalue' HTTP/1.1

Пример запроса

Сведения о том, как получить последнюю версию x-ms-version:, см. в разделе 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

Функция GetProtectionKeyId получает отпечаток сертификата X.509, который используется для обеспечения установки на компьютере правильного сертификата при шифровании пользовательского ключа контента. Список возможных значений для параметра contentKeyType сопоставляется со значениями перечислений ContentKeyType на сущности ContentKey. Дополнительные сведения см. в разделе Свойства сущности ContentKey.

Метод Универсальный код ресурса (URI) запроса Версия HTTP
GET <https:// accountname.restv2>.<location.media.azure.net/api/GetProtectionKeyId?contentKeyType>=value HTTP/1.1

Пример запроса

Сведения о том, как получить последнюю версию x-ms-version:, см. в разделе 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 получает особый сертификат X.509, который должен быть использован для шифрования пользовательского ключа контента.

Метод Универсальный код ресурса (URI) запроса Версия HTTP
GET <https:// accountname.restv2>.<location.media.azure.net/api/GetProtectionKey?ProtectionKeyId>='value' HTTP/1.1

Пример запроса

Сведения о том, как получить последнюю версию x-ms-version:, см. в разделе 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

Если вы хотите получить зашифрованный ключ содержимого из Служб мультимедиа, вызовите RebindContentKey и передайте идентификатор ContentKey и сертификат X.509 (только с открытым ключом), который использовался для шифрования ключей содержимого шифрования хранилища или общих ключей защиты. Если вызвать RebindContentKey и передать пустую строку параметру x509Certificate, то ключ контента будет создан на основе base64 и вернется сброшенным.

Метод Универсальный код ресурса (URI) запроса Версия HTTP
GET <https:// accountname.restv2>.<location.media.azure.net/api/RebindContentKey?id>='contentkeyid'&x509Certificate='URL-encodedvalue' HTTP/1.1

Пример запроса

Сведения о том, как получить последнюю версию x-ms-version:, см. в разделе 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

См. также:

REST служб мультимедиа