Help Center/ Live/ Media Live API Reference/ Flows/ Querying Flows
Updated on 2025-12-05 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Flows

Function

Queries flows.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

live:ott:listFlow

List

-

-

-

-

URI

GET /v1/{project_id}/flows

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

limit

No

Integer

Number of records on each page.

The value ranges from 1 to 100

and defaults to 10.

offset

No

Integer

Offset, which is the position where the query starts. The value must be greater than or equal to 0.

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

total

Integer

Total number

flows

Array of ListFlowRespItem objects

Flow list
Table 5 ListFlowRespItem

Parameter

Type

Description

name

String

Flow name

region

String

Region

flow_id

String

Flow ID

status

String

Status. The value can be ACTIVE (running) or STANDBY (not started).

description

String

Description

protocol

String

Protocol. The value can be srt-caller or srt-listener.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Example Requests

None

Example Responses

Status code: 200

Response to the request for querying flows

{
  "total" : 8,
  "flows" : [ {
    "name" : "test",
    "region" : "cn-north-5",
    "flow_id" : "fcbc63d1-06d8-47ba-8fd9-cd0096b72f6d",
    "status" : "STANDBY",
    "description" : "test",
    "protocol" : "srt-caller"
  } ]
}

Status code: 400

Response indicating an error

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

Status Codes

Status Code

Description

200

Response to the request for querying flows

400

Response indicating an error

Error Codes

See Error Codes.

Parent topic: Flows