创建链接

最近更新时间:2024-04-03 11:14:23

我的收藏

1. 接口描述

接口请求域名: cme.tencentcloudapi.com 。

创建媒体链接或分类路径链接,将资源信息链接到目标。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateLink。
Version String 公共参数,本接口取值:2019-10-29。
Region String 公共参数,本接口不需要传递此参数。
Platform String 平台 Id,指定访问的平台。关于平台概念,请参见文档 平台
示例值:test
Type String 链接类型,可取值有:
  • CLASS: 分类链接;
  • MATERIAL:媒体文件链接。

  • 示例值:MATERIAL
    Name String 链接名称,不能超过30个字符。
    示例值:link
    Owner Entity 链接归属者。
    DestinationId String 目标资源Id。可取值有:
  • 当 Type 为 MATERIAL 时填媒体 ID;
  • 当 Type 为 CLASS 时填写分类路径。

  • 示例值:5fec3806b4e0960001ed9ce2
    DestinationOwner Entity 目标资源归属者。
    ClassPath String 链接的分类路径,如填"/a/b"则代表链接属于该分类路径,不填则默认为根路径。
    示例值:/a/b
    Operator String 操作者。如不填,默认为 cmeid_system,表示平台管理员操作,可以创建任意源及目标资源的链接。如果指定操作者,则操作者必须对源资源有读权限,对目标媒体有写权限。
    示例值:60097a8a8ea83d00017b484b

    3. 输出参数

    参数名称 类型 描述
    MaterialId String 新建链接的媒体 Id。
    示例值:5fec3806b4e0960001ed9ce5
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 创建指向分类的链接

    创建指向分类路径为 /a/c 的链接。

    输入示例

    https://cme.tencentcloudapi.com/?Action=CreateLink
    &Platform=test
    &Type=CLASS
    &Name=link
    &ClassPath=/a/b
    &Owner.Id=38f5d76a1c4fbad03b26d258253fe468
    &Owner.Type=PERSON
    &DestinationId=/a/c
    &DestinationOwner.Id=38f5d76a1c4fbad03b26d258253fe468
    &DestinationOwner.Type=PERSON
    &<公共请求参数>

    输出示例

    {
        "Response": {
            "MaterialId": "5fec3806b4e0960001ed9ce61",
            "RequestId": "d1c5eb0e-e499-4419-b465-60c097fbb656"
        }
    }

    示例2 创建指向别人媒体的链接

    为媒体 ID 为 5fec38060544f4e4260001ed9ce5 且属于用户 ID 为 38f5d76a1c4fbad03b26d258253fe468 的媒体创建链接,其分类路径为 /a/b 。

    输入示例

    https://cme.tencentcloudapi.com/?Action=CreateLink
    &Platform=test
    &Type=MATERIAL
    &Name=link
    &ClassPath=/a/b
    &Owner.Id=b4f5d76a1c4fbad03b26d258847c6217
    &Owner.Type=PERSON
    &DestinationId=5fec38060544f4e4260001ed9ce5
    &DestinationOwner.Id=38f5d76a1c4fbad03b26d258253fe468
    &DestinationOwner.Type=PERSON
    &<公共请求参数>

    输出示例

    {
        "Response": {
            "MaterialId": "5fec3806b4e0960001ed9ce6",
            "RequestId": "d1c5eb0e-e499-4419-b465-60c097fbb657"
        }
    }

    示例3 创建指向自己媒体的链接

    为媒体 ID 为 5fec3806b4e0960001ed9ce2 且属于自己的媒体创建链接,其分类路径为 /a/b 。

    输入示例

    https://cme.tencentcloudapi.com/?Action=CreateLink
    &Platform=test
    &Type=MATERIAL
    &Name=link
    &ClassPath=/a/b
    &Owner.Id=b4f5d76a1c4fbad03b26d258847c6217
    &Owner.Type=PERSON
    &DestinationId=5fec3806b4e0960001ed9ce2
    &DestinationOwner.Id=b4f5d76a1c4fbad03b26d258847c6217
    &DestinationOwner.Type=PERSON
    &<公共请求参数>

    输出示例

    {
        "Response": {
            "MaterialId": "5fec3806b4e0960001ed9ce5",
            "RequestId": "d1c5eb0e-e499-4419-b465-60c097fbb65b"
        }
    }

    示例4 创建指向别人团队媒体的链接

    为媒体 ID 为 5feb077183bac900010975bf 且属于团队 ID 为 cmetid_1eaea85c92e98f87ea8984441ae40280 的媒体创建链接,其分类路径为 /a/b 。

    输入示例

    https://cme.tencentcloudapi.com/?Action=CreateLink
    &Platform=test
    &Type=MATERIAL
    &Name=link
    &ClassPath=/a/b
    &Owner.Id=b4f5d76a1c4fbad03b26d258847c6217
    &Owner.Type=PERSON
    &DestinationId=5feb077183bac900010975bf
    &DestinationOwner.Id=cmetid_1eaea85c92e98f87ea8984441ae40280
    &DestinationOwner.Type=TEAM
    &<公共请求参数>

    输出示例

    {
        "Response": {
            "MaterialId": "5fec3806b4e0960001ed9ce6",
            "RequestId": "d1c5eb0e-e499-4419-b465-60c097fbb657"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    InternalError 内部错误。
    InvalidParameter 参数错误。
    InvalidParameterValue 参数取值错误。
    InvalidParameterValue.ClassNotExist 分类不存在。
    InvalidParameterValue.ClassPath 分类路径不合法。
    InvalidParameterValue.MaterialId 媒体 ID 无效。
    InvalidParameterValue.NameLenLimt 名称字段长度超长,限制 30 个中文字符。
    InvalidParameterValue.OwnerId 归属者 ID 不合法。
    InvalidParameterValue.OwnerType 归属者类型不合法。
    InvalidParameterValue.Platform 平台参数取值错误。
    InvalidParameterValue.VodSubAppid 绑定的点播子应用无效。
    OperationDenied.PermissionDeny 权限不足,请检查对应操作者的权限。
    ResourceNotFound.Platform 平台不存在。
    UnauthorizedOperation 未授权操作。