文档

GetMediaResourceId - 获取媒体资源ID

更新时间:

将用户上传到卡片短信OSS存储的图片、视频转换成(生成)资源数据统一管理,并返回资源ID,用户可以对返回的资源ID自行管理。

接口说明

QPS 限制

本接口的单用户 QPS 限制为 300 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dysms:GetMediaResourceIdRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
ResourceTypeinteger

资源类型。

  • 1:文本
  • 2:图片。小图片限制在 100 KB 以内,大图片限制在 2 MB 以内,图片要求清晰;图片格式支持 JPG、JPEG、PNG。
  • 3:音频
  • 4:视频。视频格式支持 MP4。
说明
  • 资源类型为图片时img_rate必填。
  • 1:1 比例:oneToOne
  • 16:9 比例:sixteenToNine
  • 3:1 比例:threeToOne
  • 48:65 比例:fortyEightToSixtyFiv
  • 1
    OssKeystring

    获取的资源地址。

    oss://alicom-fc-media/1947741454322274/alicom-fc-media/pic/202205191526575398603697152.png
    FileSizelong

    文件大小,单位:Byte。

    12
    ExtendInfostring

    扩展字段。

    说明 资源类型为图片时必填。
    {\"img_rate\":\"oneToOne\"}
    Memostring

    上传资源的描述。

    图片信息

    返回参数

    名称类型描述示例值
    object

    返回数据。

    Codestring

    请求状态码。

    • 返回 OK 代表请求成功。
    • 其他错误码,请参见错误码列表
    OK
    RequestIdstring

    请求 ID。

    F07CF237-F6E3-5F77-B91B-F9B7C5DE84AB
    Successboolean

    调用接口是否成功。取值:

    • true

    • false

    true
    Dataobject

    返回数据。

    ResourceIdlong

    资源 ID。

    0
    ResUrlDownloadstring

    资源下载地址。

    http://test-example.com/download.jpg

    示例

    正常返回示例

    JSON格式

    {
      "Code": "OK",
      "RequestId": "F07CF237-F6E3-5F77-B91B-F9B7C5DE84AB",
      "Success": true,
      "Data": {
        "ResourceId": 0,
        "ResUrlDownload": "http://test-example.com/download.jpg"
      }
    }

    错误码

    HTTP status code错误码错误信息描述
    200ForbiddenActionAccess to the account is denied. Please contact the administrator.没有访问权限,请联系管理员

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    2022-07-18OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:200
    出参OpenAPI 返回结构发生变更
    • 本页导读 (1)
    文档反馈