文档首页/ 视频直播 Live/ 媒体直播API参考/ 对接CES新增API接口/ 实例查询 - ListCesInstance
更新时间：2025-10-29 GMT+08:00
在线调试
CLI示例
查看PDF
分享

实例查询 - ListCesInstance

功能介绍

新增实例查询API

调试

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

授权信息

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

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

live:ott:listCesInstances

List

-

-

-

-

URI

POST /v1/{project_id}/ott/instances

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

请求参数

表2 请求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信息。
表3 请求Body参数

参数

是否必选

参数类型

描述

namespace

是

String

命名空间

query

是

Array of query objects

查询信息

start

否

Integer

查询开始偏移

limit

否

Integer

查询限制
表4 query

参数

是否必选

参数类型

描述

dim_name

是

String

维度名称

id

否

String

维度id

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

instances

Array of instances objects

实例

total

Integer

总数
表6 instances

参数

参数类型

描述

medialive_mpc

medialive_mpc object

媒体直播转码服务

pipeline

pipeline object

通道

audio

audio object

音频
表7 medialive_mpc

参数

参数类型

描述

id

String

频道id

name

String

频道名
表8 pipeline

参数

参数类型

描述

id

String

pipeline id

name

String

pipeline name
表9 audio

参数

参数类型

描述

id

String

频道id

name

String

频道name

状态码：400

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误内容

请求示例

  • 查询medialive_mpc维度下实例cctv1下Pipeline0下所有音频实例（固定输出5个音轨实例）

    POST https://{endpoint}/v1/{project_id}/ott/instances

{
  "namespace" : "SYS.LIVE",
  "query" : [ {
    "dim_name" : "medialive_mpc",
    "id" : "test1112"
  }, {
    "dim_name" : "pipeline"
  }, {
    "dim_name" : "audio"
  } ],
  "start" : 0,
  "limit" : 100
}

  • 查询medialive_mpc维度下实例cctv1下所有pipeline实例

    POST https://{endpoint}/v1/{project_id}/ott/instances

{
  "namespace" : "SYS.LIVE",
  "query" : [ {
    "dim_name" : "medialive_mpc",
    "id" : "cctv1"
  }, {
    "dim_name" : "pipeline"
  } ],
  "start" : 0,
  "limit" : 100
}

响应示例

状态码：200

{
  "instances" : [ {
    "medialive_mpc" : {
      "id" : "test1112",
      "name" : "test1112"
    },
    "pipeline" : {
      "id" : "Pipeline0",
      "name" : "Pipeline0"
    },
    "audio" : {
      "id" : "Audio0",
      "name" : "Audio0"
    }
  }, {
    "medialive_mpc" : {
      "id" : "test1112",
      "name" : "test1112"
    },
    "pipeline" : {
      "id" : "Pipeline0",
      "name" : "Pipeline0"
    },
    "audio" : {
      "id" : "Audio1",
      "name" : "Audio1"
    }
  }, {
    "medialive_mpc" : {
      "id" : "test1112",
      "name" : "test1112"
    },
    "pipeline" : {
      "id" : "Pipeline0",
      "name" : "Pipeline0"
    },
    "audio" : {
      "id" : "Audio2",
      "name" : "Audio2"
    }
  }, {
    "medialive_mpc" : {
      "id" : "test1112",
      "name" : "test1112"
    },
    "pipeline" : {
      "id" : "Pipeline0",
      "name" : "Pipeline0"
    },
    "audio" : {
      "id" : "Audio3",
      "name" : "Audio3"
    }
  }, {
    "medialive_mpc" : {
      "id" : "test1112",
      "name" : "test1112"
    },
    "pipeline" : {
      "id" : "Pipeline0",
      "name" : "Pipeline0"
    },
    "audio" : {
      "id" : "Audio4",
      "name" : "Audio4"
    }
  } ],
  "total" : 5
}

状态码：400

请求参数不对

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

状态码

状态码

描述

200

400

请求参数不对

错误码

请参见错误码。

相关文档