最新更新:Mar-24-2023
媒体优化API受率限制API管理媒体优化配置组件,如媒体源和优化剖面图,管理媒体优化缓存和其他管理功能
完全概述媒体优化程序并如何帮助你优化网站媒体,见媒体优化指南.
API概述
媒体优化API端点使用HTTPs访问默认a端点使用下列格式:
https://mo-api.www.agrosoland.com/v1/:cloud_name/:action
API使用基础认证安全HTTP云语API密钥并API保密用于验证 。媒体优化控制台设置 > 安全 > 存取密钥.
尝试置换媒体优化服务器
,
并
CURL命令中
您应该看到响应 :
多数动作请求参数附到 URL少数几例则像JSON对象传递响应录入JSON片段并包含动作信息
缓存失效
无效介质内存并存如果您更新了源媒体并想确保媒体最优化URL提供媒体最新版本使用此功能
方法论 | 描述性 |
---|---|
Post应用/无效 |
失效所有缓存 |
失效所有缓存
无效取出内存和内存CDN上所有媒体
语法
POST/无效
所需参数
参数 | 类型 | 描述性 |
---|---|---|
URLS | 数组 | 数组达20媒体优化URL失效URL和从指定资产衍生出的任何介质无效变换参数可以在 URL中提供,但所有衍生资产均无效,不管如何 |
实例
指定两个URL失效
样本响应
采样响应
缓存热
弹出缓存优化介质,从第一个请求即备交付
方法论 | 描述性 |
---|---|
Post应用/cache_Warm_up |
温暖缓存 |
温暖缓存
从源头获取介质,在CDN缓存上提供并实现最优化最有用使用大图像视频无法飞转也可以用于需要时间补全的变换,因此导出媒体版本备妥后可首次请求缓存
语法
POST/Cache_Warm_up
所需参数
参数 | 类型 | 描述性 |
---|---|---|
URL | 字符串 | 媒体优化 URL缓存相关优化剖面图中指定的任何默认(基础)变换应用到缓存介质中也可以指定由映射函数处理的其他变换,作为 URL 的一部分 |
可选参数
参数 | 类型 | 描述性 |
---|---|---|
notification_url | 字符串 | HTTP或HTTPS URL接收响应未指明回复发送全局通知URL定义内交付设置设置云台 |
实例
不包括通知URL
样本响应
采样响应
包括通知URL
样本响应
以下是通知URL收到的样本响应
优化剖面
允许您管理优化剖面图(原称交付剖面图)。
方法论 | 描述性 |
---|---|
获取/delivery_profiles |
获取所有优化剖面 |
获取/delivery_profiles/:id |
获取细节优化剖面 |
Post应用/delivery_profiles |
创建优化剖面 |
PUT系统/delivery_profiles/:id |
更新优化剖面 |
开发者/delivery_profiles/:id |
删除优化剖面 |
获取优化剖面
列表优化剖面
语法
Get/dation_profile
实例
样本响应
响应包含数组优化剖面
获取优化剖析细节
获取单优化剖面
语法
Get/drops/
所需参数
参数 | 类型 | 描述性 |
---|---|---|
标识符 | 字符串 | ID优化剖面 |
实例
通过ID获取优化剖面图
样本响应
创建优化剖面
创建新优化剖面新建优化剖面默认禁用
语法
POST/formation_profile
所需参数
参数 | 类型 | 描述性 |
---|---|---|
显示名 | 字符串 | 显示名优化剖面 |
域名i | 字符串 | 域名标识 |
mapping_function_id | 字符串 | 映射函数标识 |
media_source_ids | 数组 | 数组媒体源码 |
可选参数
参数 | 类型 | 描述性 |
---|---|---|
路径前缀 | 字符串 | 基础URL部分识别属于优化剖面图的介质 |
default_transformation | 字符串 | 变换名称应用到剖面图中所有媒体 |
实例
创建新优化配置
样本响应
更新优化剖面
更新优化剖面
语法
PUT/formation_profiles/:id
所需参数
参数 | 类型 | 描述性 |
---|---|---|
标识符 | 字符串 | ID优化剖面 |
可选参数
参数 | 类型 | 描述性 |
---|---|---|
显示名 | 字符串 | 新显示名优化剖面 |
域名i | 字符串 | 域名标识 |
mapping_function_id | 字符串 | 映射函数标识 |
media_source_ids | 数组 | 数组媒体源码 |
路径前缀 | 字符串 | 基础URL部分识别属于优化剖面图的介质 |
default_transformation | 字符串 | 变换名称应用到剖面图中所有媒体 |
开机启动 | 布尔 | 启动状态优化剖面 |
实例
更新优化剖面图显示名
样本响应
删除优化剖面
删除单优化剖面
is_default: true
)
语法
DELETE/formation_profiles/
所需参数
参数 | 类型 | 描述性 |
---|---|---|
标识符 | 字符串 | 优化配置删除 |
实例
通过ID删除优化剖面图
样本响应
域名
允许您查看您的域名 。你需要创建支持请求设置自定义域
方法论 | 描述性 |
---|---|
获取/域 |
获取所有域名 |
获取域名
列出所有域名
语法
获取/域
实例
样本响应
响应包含数列域 。
映射函数
允许您管理映射函数
媒体优化提供两个内置映射函数,允许你具体说明媒体优化转换交付URL的一部分(除优化剖面说明定义外使用):
- 媒体优化:此映射函数满足
- 变换参数添加查询字符串交付URL,例如
https://mycloud.mo.cloudinary.net/rest/of/the/path.jpg?tx=c_fit,h_500,w_500
- 资源类型指定查询字符串,优于判定
资源类型
映射函数中的扩展如果不提供扩展效果则特别有用,例如:https://mycloud.mo.cloudinary.net/rest/of/the/path?resource_type=image
去哪儿资源类型
可设置图像显示
,视频播放
或原生
.
- 变换参数添加查询字符串交付URL,例如
- 币游国际平台:映射函数满足URL内变换参数的需要,如果媒体源为则会如此云化举例说:
https://mycloud.mo.cloudinary.net/image/upload/c_fit,h_500,w_500/v1/sample.jpg
上头模板类型
内置类型值媒体优化
并programmable_media
互斥时分创建自己的映射函数,他们得到模板类型
联想自定义
.
只能更新删除映射函数模板类型
联想自定义
.
方法论 | 描述性 |
---|---|
获取/mapping_functions |
获取所有映射函数 |
获取/mapping_functions/:id |
获取映射函数细节 |
Post应用/mapping_functions |
创建映射函数 |
PUT系统/mapping_functions/:id |
更新映射函数 |
开发者/mapping_functions/:id |
删除映射函数 |
获取映射函数
列表所有映射函数
语法
Get/mapping函数
实例
样本响应
响应包含数组映射函数
获取映射函数细节
获取单映射函数细节
语法
Get/mapping函数/:id
所需参数
参数 | 类型 | 描述性 |
---|---|---|
标识符 | 字符串 | 映射函数标识 |
实例
获取ID映射函数
样本响应
创建映射函数
创建新定制映射函数
语法
POST/mapping函数
所需参数
参数 | 类型 | 描述性 |
---|---|---|
显示名 | 字符串 | 显示名映射函数 |
代码解析 | 字符串 | 自定义代码映射函数 |
实例
创建新映射函数
样本响应
更新映射函数
更新映射函数
语法
PUT/mapping函数/:id
所需参数
参数 | 类型 | 描述性 |
---|---|---|
标识符 | 字符串 | 映射函数标识 |
可选参数
参数 | 类型 | 描述性 |
---|---|---|
显示名 | 字符串 | 新建显示名映射函数 |
代码解析 | 字符串 | 新建自定义代码映射函数 |
实例
更新映射函数显示名
样本响应
删除映射函数
删除单映射函数
语法
DELETE/映射函数/:id
所需参数
参数 | 类型 | 描述性 |
---|---|---|
标识符 | 字符串 | 映射函数标识删除 |
实例
删除ID映射函数
样本响应
媒体源
允许管理媒体源码
方法论 | 描述性 |
---|---|
获取/media_源码 |
获取所有媒体源 |
获取/media_sources/:id |
获取媒体源详 |
Post应用/media_源码 |
创建媒体源 |
PUT系统/media_sources/:id |
更新媒体源 |
开发者/media_sources/:id |
删除媒体源 |
获取媒体源
列表所有媒体源
语法
Get/media源码
实例
样本响应
响应中包含数组媒体源
获取媒体源细节
获取单媒体源的细节
语法
Get/media源码/:id
所需参数
参数 | 类型 | 描述性 |
---|---|---|
标识符 | 字符串 | 媒体源码 |
实例
获取媒体源码
样本响应
创建媒体源
创建新媒体源配置,允许媒体优化器连接媒体源
语法
POST/media_源码
所需参数
参数 | 类型 | 描述性 |
---|---|---|
显示名 | 字符串 | 显示媒体源配置名 |
uri_类型 | 字符串 | 上头介质源类型. 可能的值: |
配置 | JSON系统 | 配置参数类型媒体源 网站:不适用 s3- 看s3设置细节参数 :
gs系统- 看Google存储设置细节参数 :
网路- 看web地址设置细节参数 :
云化- 看云化设置细节参数 :
|
实例
创建 S3媒体源配置
样本响应
更新媒体源
更新单媒体源配置
语法
PUT/media_源码/:id
所需参数
参数 | 类型 | 描述性 |
---|---|---|
标识符 | 字符串 | 媒体源配置标识 |
可选参数
只需指定参数更新 if更新配置
参数,你必须提供所有那些为uri_类型
.
参数 | 类型 | 描述性 |
---|---|---|
显示名 | 字符串 | 媒体源新显示名 |
uri_类型 | 字符串 | 上头介质源类型. 可能的值: |
配置 | JSON系统 | 配置参数类型媒体源 网站:不适用 s3- 看s3设置细节参数 :
gs系统- 看Google存储设置细节参数 :
网路- 看web地址设置细节参数 :
云化- 看云化设置细节参数 :
|
实例
更新媒体源配置显示名
样本响应
更新媒体源配置配置的配置参数
样本响应
删除媒体源
删除单媒体源配置
语法
DELETE/media_源码/:id
所需参数
参数 | 类型 | 描述性 |
---|---|---|
标识符 | 字符串 | 媒体源码删除 |
实例
删除媒体源配置
样本响应
平市
测试媒体优化API可达性
方法论 | 描述性 |
---|---|
获取/ping |
Ping媒体优化服务器 |
Ping媒体优化服务器
检查媒体优化API可达并接受请求
语法
Get/ping
实例
样本响应
响应包含媒体优化服务器当前状态
变换
允许你管理命名变换.
方法论 | 描述性 |
---|---|
获取/transformations |
获取全部变换 |
获取/transformations/:transformation_name |
获取变换细节 |
Post应用/transformations/:transformation_name |
创建命名变换 |
PUT系统/transformations/:transformation_name |
更新变换 |
开发者/transformations/:transformation_name |
删除变换 |
获取变换
列表所有变换
语法
获取/转换
可选参数
参数 | 类型 | 描述性 |
---|---|---|
最大结果 | 整数 | 最大变换返回数(最多500次)。默认值 :10 . |
ext_cror | 字符串 | 请求返回结果比返回结果多最大结果 中,ext_cror 值返回响应之后可指定此值为ext_cror 参数响应请求 |
实例
列表全部变换, 一次返回二 :
样本响应
响应包含数组变换万一变换数超过最大结果
值计算ext_cror
参数还原可指定此值为ext_cror
参数列请求
获取变换细节
获取单变细节
语法
GET /transformations/:transformation_name
所需参数
参数 | 类型 | 描述性 |
---|---|---|
transformation_name | 字符串 | 名变换 |
实例
取名变换 :
样本响应
创建命名变换
创建新命名变换
语法
POST /transformations/:transformation_name
所需参数
参数 | 类型 | 描述性 |
---|---|---|
transformation_name | 字符串 | 名变换 |
变换 | 字符串 | 变换参数 |
实例
创建命名变换
样本响应
更新变换
更新单变换
语法
PUT /transformations/:transformation_name
所需参数
参数 | 类型 | 描述性 |
---|---|---|
transformation_name | 字符串 | 名变换 |
变换 | 字符串 | 新建变换参数 |
实例
更新小填充
变换到指定的异高度 :
样本响应
删除变换
删除单变换
语法
DELETE /transformations/:transformation_name
所需参数
参数 | 类型 | 描述性 |
---|---|---|
transformation_name | 字符串 | 名称变换或变换参数 |
实例
删除名变换
样本响应
用法
允许获取关于Media优化账号使用细节状况报告
方法论 | 描述性 |
---|---|
获取/用法 |
获取账户使用细节 |
获取账户使用细节
获取媒体优化账户使用细节
语法
Get/usage
可选参数
参数 | 类型 | 描述性 |
---|---|---|
日期显示 | 字符串 | 日期使用报表必须在最后三个月内提供格式:d-m-yyyyy .默认:当前日期 |
实例
返回使用报告2021年2月21日(21-02-2021):
样本响应
响应包含媒体优化用法