Help Center/ Live/ Media Live API Reference/ New APIs Integrated with Cloud Eye/ Querying Dimension Configurations
Updated on 2025-08-28 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Dimension Configurations

Function

Added the API for querying dimension configurations.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see "Obtaining a Project ID".
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

namespace

Yes

String

Namespace, such as SYS.LIVE, is consistent with the namespace used by the service when reporting metrics.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token. This parameter is mandatory when token authentication is used. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Authorization

No

String

Authentication information. This parameter is mandatory for AK/SK authentication.

X-Sdk-Date

No

String

Request time. This parameter is mandatory for AK/SK authentication.

X-Project-Id

No

String

Project ID. This parameter is mandatory for AK/SK authentication.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

query

query object

Response to a Cloud Eye query
Table 5 query

Parameter

Type

Description

medialive_mpc

CesDimsItem object

Media Live transcoding service

pipeline

CesDimsItem object

Channel

audio

CesDimsItem object

Audio

medialive_cdn

CesDimsItem object

Media Live CDN service

medialive_package

CesDimsItem object

Media Live packaging service

medialive_connect

CesDimsItem object

Media Live service for sending and receiving streams

medialive_tailor

CesDimsItem object

Media Live advertising service
Table 6 CesDimsItem

Parameter

Type

Description

params

Array of strings

Query parameter

display

display object

Information displayed
Table 7 display

Parameter

Type

Description

id

id object

Query ID
Table 8 id

Parameter

Type

Description

zh-cn

String

Chinese name

en-us

String

English name

Status code: 400

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Example Requests

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

Example Responses

Status code: 200

Succeeded.

{
  "query" : {
    "medialive_mpc" : {
      "params" : [ "id" ],
      "display" : {
        "id" : {
          "zh-cn" : "Channel",
          "en-us" : "Channel"
        }
      }
    },
    "pipeline" : {
      "params" : [ "id" ],
      "display" : {
        "id" : {
          "zh-cn" : "Channel",
          "en-us" : "Pipeline"
        }
      }
    },
    "audio" : {
      "params" : [ "id" ],
      "display" : {
        "id" : {
          "zh-cn" : "Audio",
          "en-us" : "Audio"
        }
      }
    },
    "medialive_cdn" : {
      "params" : [ "id" ],
      "display" : {
        "id" : {
          "zh-cn" : "Domain name",
          "en-us" : "Domain"
        }
      }
    },
    "medialive_package" : {
      "params" : [ "id" ],
      "display" : {
        "id" : {
          "zh-cn" : "Channel",
          "en-us" : "Channel"
        }
      }
    },
    "medialive_connect" : {
      "params" : [ "id" ],
      "display" : {
        "id" : {
          "zh-cn" : "Stream",
          "en-us" : "Flow"
        }
      }
    },
    "medialive_tailor" : {
      "params" : [ "id" ],
      "display" : {
        "id" : {
          "zh-cn" : "Configuration name",
          "en-us" : "Configuration Name"
        }
      }
    }
  }
}

Status code: 400

Request parameter verification failed.

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

Status Codes

Status Code

Description

200

Succeeded.

400

Request parameter verification failed.

Error Codes

See Error Codes.