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

实例查询 - ListCesInstance

功能介绍

新增实例查询API

授权信息

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

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

live:ott:listCesInstances

List

-

-

-

-

URI

POST /v1/{project_id}/ott/instances

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

[1,32]

默认取值：

不涉及

请求参数

表2 请求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]

默认取值：

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

namespace

是

String

参数解释：

命名空间

约束限制：

不涉及

取值范围：

  • SYS.LIVE

默认取值：

不涉及

query

是

Array of query objects

参数解释：

查询信息，限制[1,12]个。

约束限制：

不涉及

start

否

Integer

参数解释：

查询开始偏移

约束限制：

不涉及

取值范围：

[0, 2147483647]

默认取值：

不涉及

limit

否

Integer

参数解释：

查询限制

约束限制：

不涉及

取值范围：

[0, 2147483647]

默认取值：

不涉及

表4 query

参数

是否必选

参数类型

描述

dim_name

是

String

参数解释：

维度名称

约束限制：

不涉及

取值范围：

限制[1,256]个字符

默认取值：

不涉及

id

否

String

参数解释：

维度id

约束限制：

不涉及

取值范围：

限制[1,256]个字符

默认取值：

不涉及

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

instances

Array of instances objects

参数解释：

实例，限制[1,12]个。

total

Integer

参数解释：

总数

取值范围：

1~1000

表6 instances

参数

参数类型

描述

medialive_mpc

medialive_mpc object

参数解释：

媒体直播转码服务

pipeline

pipeline object

参数解释：

通道

audio

audio object

参数解释：

音频

表7 medialive_mpc

参数

参数类型

描述

id

String

参数解释：

频道id

取值范围：

限制[1,64]个字符

name

String

参数解释：

频道名

取值范围：

限制[1,64]个字符

表8 pipeline

参数

参数类型

描述

id

String

参数解释：

pipeline id

取值范围：

限制[1,64]个字符

name

String

参数解释：

pipeline name

取值范围：

限制[1,64]个字符

表9 audio

参数

参数类型

描述

id

String

参数解释：

频道id

取值范围：

限制[1,64]个字符

name

String

参数解释：

频道name

取值范围：

限制[1,64]个字符

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

请求参数不对

错误码

请参见错误码。