文档首页/ 视频直播 Live/ 媒体直播API参考/ 对接CES新增API接口/ 维度配置信息查询
更新时间：2025-09-12 GMT+08:00
在线调试
CLI示例
查看PDF
分享

维度配置信息查询

功能介绍

新增维度配置信息查询API

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/{project_id}/ott/dims-info

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方法请参考获取项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

namespace

是

String

命名空间，如 SYS.LIVE，与服务上报指标时使用的namespace一致。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token，使用Token鉴权方式时为必填项。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

Authorization

否

String

使用AK/SK方式认证时必填，携带的鉴权信息。

X-Sdk-Date

否

String

请求的发生时间，使用AK/SK方式认证时为必填项。

X-Project-Id

否

String

使用AK/SK方式认证时为必填项，携带项目ID信息。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

query

query object

ces查询响应内容
表5 query

参数

参数类型

描述

medialive_mpc

CesDimsItem object

媒体直播转码服务

pipeline

CesDimsItem object

通道

audio

CesDimsItem object

音频

medialive_cdn

CesDimsItem object

媒体直播CDN服务

medialive_package

CesDimsItem object

媒体直播打包服务

medialive_connect

CesDimsItem object

媒体直播收发流服务

medialive_tailor

CesDimsItem object

媒体直播广告服务
表6 CesDimsItem

参数

参数类型

描述

params

Array of strings

查询参数

display

display object

展示内容
表7 display

参数

参数类型

描述

id

id object

查询ID
表8 id

参数

参数类型

描述

zh-cn

String

中文名称

en-us

String

英文名称

状态码：400

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误内容

请求示例

GET https://{endpoint}/v1/{project_id}/ott/dims-info?namespace=SYS.LIVE

响应示例

状态码：200

成功

{
  "query" : {
    "medialive_mpc" : {
      "params" : [ "id" ],
      "display" : {
        "id" : {
          "zh-cn" : "频道",
          "en-us" : "Channel"
        }
      }
    },
    "pipeline" : {
      "params" : [ "id" ],
      "display" : {
        "id" : {
          "zh-cn" : "通道",
          "en-us" : "Pipeline"
        }
      }
    },
    "audio" : {
      "params" : [ "id" ],
      "display" : {
        "id" : {
          "zh-cn" : "音频",
          "en-us" : "Audio"
        }
      }
    },
    "medialive_cdn" : {
      "params" : [ "id" ],
      "display" : {
        "id" : {
          "zh-cn" : "域名",
          "en-us" : "Domain"
        }
      }
    },
    "medialive_package" : {
      "params" : [ "id" ],
      "display" : {
        "id" : {
          "zh-cn" : "频道",
          "en-us" : "Channel"
        }
      }
    },
    "medialive_connect" : {
      "params" : [ "id" ],
      "display" : {
        "id" : {
          "zh-cn" : "流",
          "en-us" : "Flow"
        }
      }
    },
    "medialive_tailor" : {
      "params" : [ "id" ],
      "display" : {
        "id" : {
          "zh-cn" : "配置名",
          "en-us" : "Configuration Name"
        }
      }
    }
  }
}

状态码：400

请求参数校验失败

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "Request parameters is invalid"
}

状态码

状态码

描述

200

成功

400

请求参数校验失败

错误码

请参见错误码。

相关文档