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

维度配置信息查询 - ListCesDimsInfo

功能介绍

新增维度配置信息查询API

授权信息

账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

live:ott:getDimsInfo

List

-

-

-

-

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID，获取方法请参考获取项目ID。

约束限制：

不涉及

取值范围：

[1,32]

默认取值：

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

namespace

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

SYS.LIVE

默认取值：

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

参数解释：

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

约束限制：

不涉及

取值范围：

[1,256]

默认取值：

不涉及

Authorization

否

String

参数解释：

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

约束限制：

不涉及

取值范围：

[1,256]

默认取值：

不涉及

X-Sdk-Date

否

String

参数解释：

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

约束限制：

不涉及

取值范围：

[1,256]

默认取值：

不涉及

X-Project-Id

否

String

参数解释：

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

约束限制：

不涉及

取值范围：

[1,64]

默认取值：

不涉及

响应参数

状态码：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

参数解释：

广告维度

region

CesDimsItem object

参数解释：

region维度

表6 CesDimsItem

参数

参数类型

描述

params

Array of strings

参数解释：

查询参数

取值范围：

限制[1,12]个

display

display object

参数解释：

展示内容

表7 display

参数

参数类型

描述

id

id object

参数解释：

查询ID

表8 id

参数

参数类型

描述

zh-cn

String

参数解释：

中文名称

取值范围：

限制[1,256]个字符

en-us

String

参数解释：

英文名称

取值范围：

限制[1,256]个字符

状态码：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"
        }
      }
    },
    "region" : {
      "params" : [ "id" ],
      "display" : {
        "id" : {
          "zh-cn" : "区域",
          "en-us" : "Region"
        }
      }
    },
    "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

请求参数校验失败

错误码

请参见错误码。