你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
REST API 函数
以下函数通过执行各种任务(例如取消作业、检索保护密钥等)来支持Microsoft Azure 媒体服务实体。
CancelJob
. 采用以下参数:类型为 的 Edm.String
jobid。
GetProtectionKeyId
. 采用以下参数:类型为 的 Edm.Int32
contentKeyType。 返回 Edm.String
。
GetProtectionKey
. 采用以下参数:类型的 protectionKeyIdEdm.String
。 返回 Edm.String
。
CreateFileInfos
. 采用以下参数:类型的 assetidEdm.String
。
RebindContentKey
. 采用以下参数:id 的类型Edm.String
,类型为 Edm.String
x509Certificate。 返回 Edm.String
。
Publish
. 采用以下参数:类型的 assetidMicrosoft.Cloud.Media.Vod.Rest.Data.Models.Asset
。
GetKeyDeliveryUrl
. 采用以下参数:类型的 contentKeyMicrosoft.Cloud.Media.Vod.Rest.Data.Models.ContentKey
、类型的 keyDeliveryTypeEdm.String
。 返回 Edm.Int32
。
Start
. 采用以下参数:类型的 streamingEndpointMicrosoft.Cloud.Media.Vod.Rest.Data.Models.StreamingEndpoint
。
Start
. 采用以下参数:类型的通道Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel
。
Start
. 采用以下参数:类型的程序Microsoft.Cloud.Media.Vod.Rest.Data.Models.Program
。
Stop
. 采用以下参数:类型的 streamingEndpointMicrosoft.Cloud.Media.Vod.Rest.Data.Models.StreamingEndpoint
。
Stop
. 采用以下参数:类型的通道Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel
。
Stop
. 采用以下参数:类型的程序Microsoft.Cloud.Media.Vod.Rest.Data.Models.Program
。
Scale
. 采用以下参数:类型的 streamingEndpointMicrosoft.Cloud.Media.Vod.Rest.Data.Models.StreamingEndpoint
、类型的 scaleUnitsEdm.String
。
ShowSlate
. 采用以下参数:类型的通道Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel
、类型的持续时间Edm.Time
、类型的 assetIdEdm.String
。
StartAdvertisement
. 采用以下 参数:channel of Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel
type、 duration of Edm.Time
type、 cueId of Edm.Int32
type、 showSlate of Edm.Boolean
type。
HideSlate
. 采用以下参数:类型的通道Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel
。
EndAdvertisement
. 采用以下参数:类型的通道Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel
、类型为的Edm.Int32
cueId。
Reset
. 采用以下参数:类型的通道Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel
。
重要
访问媒体服务中的实体时,必须在 HTTP 请求中设置特定标头字段和值。
有关详细信息,请参阅 设置媒体服务 REST API 开发 和使用 媒体服务 REST API 连接到媒体服务。
本主题的剩余部分显示如何使用 REST 调用函数的几个示例。
CancelJob
可以通过调用 CancelJob 并传入当前正在运行的作业的作业 ID 来取消正在运行的作业。
方法 | 请求 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 函数并传入与你上载到 BLOB 存储中的媒体文件关联的资产 ID 可创建文件实体。 有关详细信息,请参阅将文件上载到 BLOB 存储。
方法 | 请求 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 参数的可能值列表与 ContentKey 实体上的 ContentKeyType 枚举值对应。 有关详细信息,请参阅 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 ID 和 X.509 证书 (,其中仅包含用于加密明文存储加密/通用保护内容密钥的公钥) 。 如果调用 RebindContentKey 并传入空字符串到 x509 证书参数,则会对内容密钥进行 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