Funciones de la API de REST
Las siguientes funciones admiten las entidades de Microsoft Azure Media Services realizando varias tareas, como cancelar trabajos, recuperar claves de protección, etc.
CancelJob. Toma el parámetro siguiente: jobid de Edm.String tipo.
GetProtectionKeyId. Toma el parámetro siguiente: contentKeyType de Edm.Int32 tipo. Devuelve Edm.String.
GetProtectionKey. Toma el siguiente parámetro: protectionKeyId de Edm.String tipo. Devuelve Edm.String.
CreateFileInfos. Toma el parámetro siguiente: assetid de Edm.String tipo.
RebindContentKey. Toma los parámetros siguientes: id . de Edm.String tipo, x509Certificate de Edm.String tipo. Devuelve Edm.String.
Publish. Toma el parámetro siguiente: assetid de Microsoft.Cloud.Media.Vod.Rest.Data.Models.Asset tipo.
GetKeyDeliveryUrl. Toma los parámetros siguientes: contentKey de Microsoft.Cloud.Media.Vod.Rest.Data.Models.ContentKey tipo, keyDeliveryType de Edm.String tipo. Devuelve Edm.Int32.
Start. Toma el parámetro siguiente: streamingEndpoint de Microsoft.Cloud.Media.Vod.Rest.Data.Models.StreamingEndpoint tipo.
Start. Toma el siguiente parámetro: canal de Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel tipo.
Start. Toma el siguiente parámetro: programa de Microsoft.Cloud.Media.Vod.Rest.Data.Models.Program tipo.
Stop. Toma el parámetro siguiente: streamingEndpoint de Microsoft.Cloud.Media.Vod.Rest.Data.Models.StreamingEndpoint tipo.
Stop. Toma el siguiente parámetro: canal de Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel tipo.
Stop. Toma el siguiente parámetro: programa de Microsoft.Cloud.Media.Vod.Rest.Data.Models.Program tipo.
Scale. Toma los parámetros siguientes: streamingEndpoint de Microsoft.Cloud.Media.Vod.Rest.Data.Models.StreamingEndpoint tipo, scaleUnits de Edm.String tipo.
ShowSlate. Toma los parámetros siguientes: canal de Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel tipo, duración de Edm.Time tipo, assetId de Edm.String tipo.
StartAdvertisement. Toma los parámetros siguientes: canal de Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel tipo, duración de Edm.Time tipo, cueId de Edm.Int32 tipo, showSlate de Edm.Boolean tipo.
HideSlate. Toma el siguiente parámetro: canal de Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel tipo.
EndAdvertisement. Toma los parámetros siguientes: canal de Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel tipo, cueId de Edm.Int32 tipo.
Reset. Toma el siguiente parámetro: canal de Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel tipo.
Importante
Al obtener acceso a las entidades de Media Services, debe establecer los campos de encabezado específicos y los valores en las solicitudes HTTP.
Para obtener más información, consulte Configuración para el desarrollo de api REST de Media Services y conexión a Media Services con la API REST de Media Services.
El resto del tema muestra algunos ejemplos de cómo llamar a funciones mediante REST.
CancelJob
Para cancelar los trabajos en ejecución, puede llamar a CancelJob y pasar el identificador de un trabajo en ejecución.
| Método | URI de solicitud | Versión HTTP |
|---|---|---|
| GET | <https:// accountname.restv2>.<location.media.azure.net/api/CancelJob?jobid>='URL-encodedvalue' | HTTP/1.1 |
Solicitud de ejemplo
Para obtener la versión más reciente x-ms-version:, consulte REST de 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
Para crear una entidad File, se usa la función CreateFileInfos y se pasa el identificador del recurso asociado al archivo multimedia cargado en el almacenamiento blob. Para obtener más información, vea Carga de un archivo en el almacenamiento de blob.
| Método | URI de solicitud | Versión HTTP |
|---|---|---|
| GET | <https:// accountname.restv2>.<location.media.azure.net/api/CreateFileInfos?assetid>='URL-encodedvalue' | HTTP/1.1 |
Solicitud de ejemplo
Para obtener la versión más reciente x-ms-version:, consulte REST de 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
La función GetProtectionKeyId recupera la huella digital de certificado X.509 que se usa para asegurarse de que tiene instalado en la máquina el certificado correcto al cifrar la clave de contenido que define el usuario. La lista de valores posibles para el parámetro contentKeyType se corresponde con los valores de enumeración de ContentKeyType de la entidad ContentKey. Para obtener más información, vea Propiedades de la entidad ContentKey.
| Método | URI de solicitud | Versión HTTP |
|---|---|---|
| GET | <https:// accountname.restv2>.<location.media.azure.net/api/GetProtectionKeyId?contentKeyType>=value | HTTP/1.1 |
Solicitud de ejemplo
Para obtener la versión más reciente x-ms-version:, consulte REST de 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 recupera el certificado X.509 específico que se debe usar para cifrar la clave de contenido que define el usuario.
| Método | URI de solicitud | Versión HTTP |
|---|---|---|
| GET | <https:// accountname.restv2>.<location.media.azure.net/api/GetProtectionKey?ProtectionKeyId>='value' | HTTP/1.1 |
Solicitud de ejemplo
Para obtener la versión más reciente x-ms-version:, consulte REST de 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
Si desea recuperar la clave de contenido cifrada de Media Services, llame a RebindContentKey y pase el identificador de ContentKey y el certificado X.509 (con solo la clave pública) que se usó para cifrar las claves de contenido de protección comunes o cifrado de almacenamiento sin cifrar. Si llama a RebindContentKey y pasa una cadena en blanco al parámetro x509Certificate, la clave de contenido se codifica a base64 y se devuelve sin cifrar.
| Método | URI de solicitud | Versión HTTP |
|---|---|---|
| GET | <https:// accountname.restv2>.<location.media.azure.net/api/RebindContentKey?id>='contentkeyid'&x509Certificate='URL-encodedvalue' | HTTP/1.1 |
Solicitud de ejemplo
Para obtener la versión más reciente x-ms-version:, consulte REST de 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