GetMediaConnectFlowInput API Reference - Intelligent Media Services

Retrieves the input information of a MediaConnect instance.

Operation description

If the specified Flow instance ID does not exist, the API returns an error.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ice:GetMediaConnectFlowInput

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
FlowId	string	Yes	The ID of the Flow instance.	34900dc6-90ec-4968-af3c-fcd87f231a5f

Response elements

Element	Type	Description	Example
	object	Response content.
Content	object	The response body.
InputName	string	The input name.	AliTestInput
InputProtocol	string	The input type. Valid values: RTMP-PUSH : RTMP-PUSH SRT-Caller : SRT-Caller RTMP-PULL : RTMP-PULL SRT-Listener : SRT-Listener Flow : Flow	RTMP-PUSH
MaxBitrate	integer	The input bitrate, in bps.	2000000
Cidrs	string	The IP address whitelist in CIDR format. Separate multiple IP address segments with commas.	10.211.0.0/17
InputUrl	string	The input URL.	rtmp://1.2.3.4:1935/live/AliTestInput_8666ec062190f00e263012666319a5be
SrtLatency	integer	The SRT latency in milliseconds (ms). This parameter is required only when the input type is SRT-Listener or SRT-Caller.	1000
SrtPassphrase	string	The SRT encryption key. This parameter is required only when the input type is SRT-Listener or SRT-Caller.	FICUBPX4Q77DYHRF
SrtPbkeyLen	integer	The SRT encryption key length. This parameter is required only when the input type is SRT-Listener or SRT-Caller. Valid values: 0 : 0 16 : 16 24 : 24 32 : 32	32
PairOutputName	string	The output name of the peer Flow. This parameter is required only when the input type is Flow.	AliTestOutput
PairFlowId	string	The ID of the peer Flow instance. This parameter is required only if the output type is Flow.	05c3adf4-aa0e-421d-a991-48ceae3e642e
CreateTime	string	The time when the input was created.	2024-07-18T01:29:24Z
BackupInputName	string	The name of the backup input.
BackupCidrs	string	The IP address whitelist for the backup input.
BackupInputUrl	string	The URL of the backup input.
BackupSrtLatency	integer	The SRT latency for the backup input.
BackupSrtPassphrase	string	The SRT encryption key for the backup input.
BackupSrtPbkeyLen	integer	The SRT encryption key length for the backup input.
BackupCreateTime	string	The time when the backup input was created.
BackupMaxBitrate	integer	The bitrate of the backup input.
InputStatus	string	The input status. It indicates whether the primary stream is being pushed.
BackupInputStatus	string	The status of the backup input. It indicates whether the backup stream is being pushed.
InnerInputUrl	string
BackupInnerInputUrl	string
Description	string	The description of the API call.	OK
RetCode	integer	The error code returned. A value of 0 indicates success.	0
RequestId	string	The request ID.	D4C231DF-103A-55FF-8D09-E699552457DE

Examples

Success response

JSON format

{
  "Content": {
    "InputName": "AliTestInput",
    "InputProtocol": "RTMP-PUSH",
    "MaxBitrate": 2000000,
    "Cidrs": "10.211.0.0/17",
    "InputUrl": "rtmp://1.2.3.4:1935/live/AliTestInput_8666ec062190f00e263012666319a5be",
    "SrtLatency": 1000,
    "SrtPassphrase": "FICUBPX4Q77DYHRF",
    "SrtPbkeyLen": 32,
    "PairOutputName": "AliTestOutput",
    "PairFlowId": "05c3adf4-aa0e-421d-a991-48ceae3e642e",
    "CreateTime": "2024-07-18T01:29:24Z",
    "BackupInputName": "",
    "BackupCidrs": "",
    "BackupInputUrl": "",
    "BackupSrtLatency": 0,
    "BackupSrtPassphrase": "",
    "BackupSrtPbkeyLen": 0,
    "BackupCreateTime": "",
    "BackupMaxBitrate": 0,
    "InputStatus": "",
    "BackupInputStatus": "",
    "InnerInputUrl": "",
    "BackupInnerInputUrl": ""
  },
  "Description": "OK",
  "RetCode": 0,
  "RequestId": "D4C231DF-103A-55FF-8D09-E699552457DE"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.