调用 MGetMaterial 接口批量获取素材的详细信息。可以通过素材 ID、素材类型、素材标题,以及素材的起始时间和结束时间查询符合条件的素材。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | MGetMaterial | 接口名称。当前 API 的名称为 MGetMaterial。 |
Version | String | 是 | 2018-01-01 | 接口版本。当前 API 的版本为 2018-01-01。 |
Space | String | 是 | yhss | 素材所属的空间名称。 |
Format | String | 否 | png,jpg,jpeg,gif,webp | 素材的格式。 |
Limit | Long | 否 | 12 | 分页查询时每页返回的素材数量。 |
Offset | Long | 否 | 0 | 分页查询时的起始记录位置,表示从第几条记录开始返回。 |
Mid | String | 否 | mid_1234567890abcdef | 素材 ID。 |
Vid | String | 否 | v02b69g10000*** | 视频 ID。 |
Title | String | 否 | AI图片超分.png | 素材标题。 |
Category | String | 否 | image | 素材类型。支持以下素材类型:
|
SortBy | String | 否 | Title | 查询结果的排序方式。支持以下字段:
|
Order | String | 否 | desc | 查询结果的排序顺序。支持的取值如下所示:
|
StartTime | String | 否 | 2023-01-01T00:00:00Z | 查询素材的起始时间,筛选在该时间之后创建或修改的素材。格式为 YYYY-MM-DDTHH:MM:SSZ。 |
EndTime | String | 否 | 2023-12-31T23:59:59Z | 查询素材的结束时间,筛选在该时间之前创建或修改的素材。格式为 YYYY-MM-DDTHH:MM:SSZ。 |
下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
MaterialSet | Object | - | 素材信息。 |
MaterialInfos | Object[] | - | 素材信息的集合。 |
Vid | String | i0032xxxxxxxxxxxxxxxx7rap4frg | 视频 ID。 |
Mid | String | i0032xxxxxxxxxxxxxxxx7rap4frg | 素材 ID。 |
MaterialBasicInfo | Object | - | 素材基本信息。 |
SpaceName | String | yhss | 空间名称。 |
Vid | String | i0032xxxxxxxxxxxxxxxx7rap4frg | 视频 ID。 |
Mid | String | i0032xxxxxxxxxxxxxxxx7rap4frg | 素材 ID。 |
Title | String | AI图片超分.png | 素材标题。 |
Filename | String | AI图片超分.png | 素材所属的文件名称。 |
Description | String | 这是一张用于展示 AI 图片超分效果的示例图片。 | 素材的描述信息,用于简要说明素材的内容或用途。 |
Category | String | image | 素材类型。支持以下素材类型:
|
Format | String | png | 素材的格式,例如图片素材的格式可能是 png、jpg 等,视频素材的格式可能是 mp4、mov等。 |
Size | Integer | 661895 | 素材的大小,单位为字节。 |
PosterUri | String | tos-vod-cn-v-444d8xxx9637/AI图片超分.png | 素材的封面图 URI。 |
CreatedAt | String | 2025-09-09 16:38:36 | 素材的创建时间,格式为 YYYY-MM-DD HH:mm:ss。 |
UpdateAt | String | 2025-09-09 16:38:36 | 素材的最后更新时间,格式为 YYYY-MM-DD HH:mm:ss。 |
StoreUri | String | tos-vod-cn-v-444d83xx637/AI图片超分.png | 素材的存储地址。 |
Md5 | String | d5b1336c2xxx1ff595d0a | 素材文件的 MD5 值,用于校验文件的完整性和一致性。 |
Height | Integer | 376 | 素材的高度,单位为像素。 |
Width | Integer | 1095 | 素材的宽度,单位为像素。 |
PosterUrl | String | https://console-image-cn.volcvod.com/tos-vod-cn-v-444d83exxx37/AI%E5%9B%BE%E7%89%87%E8%B6%85%E5%88%86.png~noop.image?sign=1760854354-r0-u0-ec9a106943e2xxx4770c097 | 素材的封面图 URL。 |
PlayUrl | String | https://console-image-cn.volcvod.com/tos-vod-cn-v-444d83xx9509637/AI%E5%9B%BE%E7%89%87%E8%B6%85%E5%88%86.png~noop.image?sign=1760854354-r0-u0-ec9axxxxe3bc4770c097 | 素材的播放 URL,用于直接访问或播放素材内容。 |
OuterImageUrl | String | https://external.example.com/images/AI%E5%9B%BE%E7%89%87%E8%B6%85%E5%88%86.png | 素材的外部图片 URL。 |
FileInfos | Null | - | 素材的文件信息。 |
InfoExt | Null | - | 素材的扩展信息。 |
Total | Integer | 1 | 返回查询到的素材数量。 |
BaseResp | Object | - | 基础响应信息。 |
StatusCode | Integer | 0 | 接口请求的状态码。 0表示成功,其他值表示不同的错误状态。 |
StatusMessage | String | success | 接口请求的状态信息。当 StatusCode 为 0 时,此时该字段返回 success,表示成功;其他状态码时,该字段会返回具体的错误信息。 |
Extra | Null | - | 接口请求的扩展信息。 |
GET https://vod.volcengineapi.com?Action=MGetMaterial&Version=2018-01-01&Space=yhss&Format=png,jpg,jpeg,gif,webp&Limit=12&Offset=0&Mid=mid_1234567890abcdef&Vid=v02b69g10000***&Title=AI图片超分.png&Category=image&SortBy=Title&Order=desc&StartTime=&EndTime=
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "MGetMaterial", "Version": "2018-01-01", "Service": "vod", "Region": "cn-north-1" }, "Result": { "MaterialSet": { "MaterialInfos": [ { "Vid": "i0032xxxxxxxxxxxxxxxx7rap4frg", "Mid": "i0032xxxxxxxxxxxxxxxx7rap4frg", "MaterialBasicInfo": { "SpaceName": "yhss", "Vid": "i0032xxxxxxxxxxxxxxxx7rap4frg", "Mid": "i0032xxxxxxxxxxxxxxxx7rap4frg", "Title": "AI图片超分.png", "Filename": "AI图片超分.png", "Description": "", "Category": "image", "Format": "png", "Size": 661895, "PosterUri": "tos-vod-cn-v-444d8xxx9637/AI图片超分.png", "CreatedAt": "2025-09-09 16:38:36", "UpdateAt": "2025-09-09 16:38:36", "StoreUri": "tos-vod-cn-v-444d83xx637/AI图片超分.png", "Md5": "d5b1336c2xxx1ff595d0a", "Height": 376, "Width": 1095, "PosterUrl": "https://console-image-cn.volcvod.com/tos-vod-cn-v-444d83exxx37/AI%E5%9B%BE%E7%89%87%E8%B6%85%E5%88%86.png~noop.image?sign=1760854354-r0-u0-ec9a106943e2xxx4770c097", "PlayUrl": "https://console-image-cn.volcvod.com/tos-vod-cn-v-444d83xx9509637/AI%E5%9B%BE%E7%89%87%E8%B6%85%E5%88%86.png~noop.image?sign=1760854354-r0-u0-ec9axxxxe3bc4770c097", "OuterImageUrl": "" }, "FileInfos": null, "InfoExt": null } ] }, "Total": 1, "BaseResp": { "StatusCode": 0, "StatusMessage": "success", "Extra": null } } }
本接口无特有的错误码。更多信息请见公共错误码。