# 媒资发布取消 - UnpublishAssets #### 功能介绍 将媒资设置为未发布状态。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/VOD/doc?api=UnpublishAssets)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-vod/vod_04_0012.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | vod:asset:unpublish | Write | assets \* | - | - | - | #### URI POST /v1.0/{project_id}/asset/status/unpublish 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，获取方法请参考[获取项目ID](https://support.huaweicloud.com/api-vod/vod_04_0211.html) | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 否 | String | 用户Token，使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 | | Authorization | 否 | String | 使用AK/SK方式认证时必选，携带的鉴权信息。 | | X-Sdk-Date | 否 | String | 使用AK/SK方式认证时必选，请求的发生时间。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | asset_id | 是 | Array of strings | VOD分配的媒资ID，仅支持查询，不支持修改。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | asset_info_array | Array of [AssetInfo] objects | 媒资状态集合。 | 表5AssetInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | asset_id | String | VOD分配的媒资ID，仅支持查询，不支持修改。 | | is_multi_transcode | Boolean | 是否是多转码模式 | | status | String | 媒资状态。 取值如下： - UNCREATED：未创建（媒资ID不存在 ） - DELETED：已删除 - CANCELLED：上传取消 - SERVER_ERROR：上传失败（点播服务端故障） - UPLOAD_FAILED：上传失败（向OBS上传失败） - CREATING：创建中 - PUBLISHED：已发布 - WAITING_TRANSCODE：待发布（转码排队中） - TRANSCODING：待发布（转码中） - TRANSCODE_FAILED：待发布（转码失败） - TRANSCODE_SUCCEED：待发布（转码成功） - CREATED：待发布（未转码） - NO_ASSET：该媒资不存在 - DELETING：正在删除 - DELETE_FAILED：删除失败 - OBS_CREATING：OBS转存方式创建中 - OBS_CREATE_FAILED： OBS转存失败 - OBS_CREATE_SUCCESS： OBS转存成功 | | description | String | 媒资子状态或描述信息。 - 对于媒资异常场景，描述具体的异常原因。 - 对于正常场景，描述媒资的处理信息。 | | base_info | [BaseInfo] object | 媒资基本信息。 | | play_info_array | Array of [PlayInfo] objects | 转码文件的播放信息。 - HLS或DASH：此数组的成员个数为n+1，n为转码输出路数。 - MP4：此数组的成员个数为n，n为转码输出路数。 | 表6BaseInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | title | String | 媒资标题。 长度不超过128个字节，UTF8编码。 | | video_name | String | 媒资文件名。 | | description | String | 媒资描述。 长度不超过1024个字节。 | | category_id | Long | 媒资分类id。 | | category_name | String | 媒资分类名称。 | | create_time | String | 媒资创建时间。 格式为yyyymmddhhmmss。必须是与时区无关的UTC时间。 | | last_modified | String | 媒资最近修改时间。 格式为yyyymmddhhmmss。必须是与时区无关的UTC时间。 | | video_type | String | 音视频文件类型。 取值如下： - 视频文件：MP4、TS、MOV、MXF、MPG、FLV、WMV、AVI、M4V、F4V、MPEG、3GP、ASF、MKV、WEBM - 音频文件：MP3、OGG、WAV、WMA、APE、FLAC、AAC、AC3、MMF、AMR、M4A、M4R、WV、MP2 | | tags | String | 媒资标签。 单个标签不超过24个字节，最多不超过16个标签。 多个用逗号分隔，UTF8编码。 | | meta_data | [MetaData] object | 视频的元数据信息。 经过视频解析后产生，包括封装格式、大小、分辨率、码率、帧率。 | | video_url | String | 原始视频文件的访问地址。 | | sign_url | String | 原视频文件的OBS临时访问地址。仅调用[查询指定媒资的详细信息](https://support.huaweicloud.com/api-vod/vod_04_0202.html)接口时才返回具体值。 | | cover_info_array | Array of [CoverInfo] objects | 封面信息。 | | subtitle_info | Array of [SubtitleInfo] objects | 字幕信息数组 | | source_path | [File_addr] object | 媒资存储参数信息。查询接口，仅媒资为托管时有返回值。 | | output_path | [File_addr] object | 媒资存储参数信息。查询接口，仅媒资为托管时有返回值。 | 表7CoverInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | cover_url | String | 封面文件的下载地址。 | 表8SubtitleInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | url | String | 字幕文件的下载地址 | | id | Integer | 字幕文件id | | type | String | 字幕文件类型，目前暂只支持"SRT"和"VTT"。 | | language | String | 字幕文件语言种类 | 表9File_addr | 参数 | 参数类型 | 描述 | |:---|:---|:---| | bucket | String | OBS的bucket名称。 | | location | String | 桶所在的区域名， 如"华北-北京四"的区域名为"cn-north-4"，创建的桶所在区域必须和点播服务所在区域保持一致。 | | object | String | 文件的存储路径。 | 表10PlayInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | play_type | String | 播放协议类型。 取值如下： - hls - dash - mp4 | | group_id | String | 所属转码组Id | | group_name | String | 所属转码组名称 | | url | String | 播放URL。 | | encrypted | Integer | 标记流是否已被加密。 取值如下： - 0：表示未加密。 - 1：表示已被加密。 默认值：0。 | | meta_data | [MetaData] object | 视频的元数据信息。 经过视频解析后产生，包括封装格式、大小、分辨率、码率、帧率。 | 表11MetaData | 参数 | 参数类型 | 描述 | |:---|:---|:---| | pack_type | String | 视频封装格式。 取值如下： - MP4 - TS - MOV - MXF - MPG - FLV - WMV - MP3 - WMA - APE - FLAC - AAC - AC3 - MMF - AMR - M4A - M4R - OGG - WAV - WV - MP2 - AVI - F4V - M4V - MPEG - HLS - DASH | | codec | String | 视频编码格式。 取值如下： - MPEG-2 - MPEG-4 - H.264 - H.265 - WMV - Vorbis - AAC - AC-3 - AMR - APE - FLAC - MP3 - MP2 - WMA - PCM - ADPCM - WavPack 说明： 如果codec返回unknown，说明不支持解析用户当前发送的音视频编码格式。 | | audio_codec | String | 音频编码格式。 须知：仅在2025/01/01之后创建的媒资元数据/转码产物包含该参数。 | | duration | Long | 视频时长，单位：秒。 若视频的原时长为非整数，则该字段值为原时长的向下取整。 若视频的原时长小于1，则该字段值为1。 | | duration_ms | Long | 视频时长，单位毫秒。 | | video_size | Long | 视频文件大小。 单位：字节。 | | width | Long | 视频宽度（单位：像素）。 - 编码为H.264的取值范围：\[32,3840\]之间2的倍数。 - 编码为H.265的取值范围：\[320,3840\]之间4的倍数。 | | hight | Long | 视频高度（单位：像素）。 - 编码为H.264的取值范围：\[32,2160\]之间2的倍数 。 - 编码为H.265的取值范围：\[240,2160\]之间4的倍数。 | | height | Long | 视频高度（单位：像素） | | bit_rate | Long | 视频平均码率。 | | frame_rate | Long | 帧率（单位：帧每秒）。 | | quality | String | 清晰度。 取值如下： - FULL_HD：超高清 - HD：高清 - SD：标清 - FLUENT：流畅 - AD：自适应 - 2K - 4K | | audio_channels | Integer | 音频的声道数。 | **状态码：403** 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | #### 请求示例 取消发布媒资 ``` POST https://{endpoint}/v1.0/{project_id}/asset/status/unpublish Content-Type: application/json { "asset_id": [ "f488337c31c8e4622f1590735b134c65", "07ba4d46463355e800c2f42f628f0631" ] } ``` #### 响应示例 **状态码：200** 处理成功返回。 ``` { "asset_info_array" : [ { "asset_id" : "f488337c31c8e4622f1590735b134c65", "status" : "UNCREATED", "description" : "Asset meta download fail, errorCode is VOD.100021010,\nerrorMsg is Internal server communication is abnormal", "base_info" : { "title" : "Avatar test test", "video_name" : "Avatar_480P.mp4", "description" : "Avatar, test", "category_id" : -1, "category_name" : "其他", "create_time" : "20180209024019", "last_modified" : "20180209024019", "video_type" : "MP4", "tags" : "mytags" } }, { "asset_id" : "07ba4d46463355e800c2f42f628f0631", "status" : "NOASSET", "description" : "no asset" } ] } ``` **状态码：403** 处理失败返回。 ``` { "error_code" : "VOD.10062", "error_msg" : "Media asset or resource does not exist, please check." } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 处理成功返回。 | | 403 | 处理失败返回。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-vod/ErrorCode.html)。