Querying Flow Details

Function

Queries flow details.

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:getFlowDetail	Read	-	-	-	-

URI

GET /v1/{project_id}/flows/detail

**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
data_display	No	String	true
flow_id	Yes	String	Flow ID

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
name	String	Flow name
region	String	Region
sources	Array of FlowSource objects	Input information
status	String	Status
flow_id	String	Flow ID
outputs	Array of FlowOutput objects	Flow output information

**Table 5** FlowSource
Parameter	Type	Description
source_listener_address	String	Ingest URL
source_listener_port	Integer	Port that pulls streams. 2077 and 2088 are not allowed.
stream_id	String	streamid of SRT stream pull
min_latency	Integer	Minimum latency, in millisecond.
cidr_whitelist	Array of strings	CIDR IP whitelist for stream push
description	String	Description
protocol	String	Protocol. The value can be srt-caller or srt-listener.
name	String	Input resource name
decryption	FlowSourceDecryption object	Flow decryption information in StreamConnect.
health_status	String	Indicates the stream push status. The options are as follows: CONNECTED: The stream is being pushed; DISCONNECTED: The stream push is interrupted.

**Table 6** FlowSourceDecryption
Parameter	Type	Description
algorithm	String	Encryption algorithm. The value can be aes128 (AES-128), aes192 (AES-192), or aes256 (AES-256).
key_type	String	Key type. The value can be speke (obtaining keys using the SPEKE protocol), static-key (static key), or srt-password (SRT key). Currently, only srt-password is supported.
passphrase	String	SRT decryption key, which is used by a flow to decrypt SRT streams.