Call ListMediaLiveInputs API to Retrieve Input Configs - IMS - Alibaba Cloud - Intelligent Media Services

Queries media live inputs.

Operation description

Queries the list of media live inputs.

QPS Limit

The per-user queries per second (QPS) limit for this API is 50. Exceeding the limit triggers rate limiting, which may affect your business. Manage your call frequency accordingly.

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:ListMediaLiveInputs

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
MaxResults	integer	No	The number of entries per page. Valid values: 1 to 100. Default value: 10 if not specified or if the value is less than 10. If the value exceeds 100, it defaults to 100.	10
Skip	integer	No	The number of entries to skip. If this value exceeds the total number of matching entries, an empty list is returned.	20
NextToken	string	No	The pagination token for retrieving the next page of results. Not required for the first request. Set this to the NextToken value returned by the previous query.	caeba0bbb2be03f84eb48b699f0a4883
SortOrder	string	No	The sort order of inputs by creation time. Valid values: asc (ascending, default) and desc (descending).	desc
Keyword	string	No	The search keyword. Supports fuzzy matching on input ID or name.	123
Types	string	No	The input types to query. Specify multiple types in a JSON array.	["RTMP_PUSH","SRT_PULL"]

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	****11-DB8D-4A9A-875B-275798****
Inputs	array<object>	The inputs.
	array<object>	The input configurations.
Type	string	The input type.	RTMP_PUSH
CreateTime	string	The time when the input was created, in the yyyy-MM-ddTHH:mm:ssZ format (UTC, ISO 8601).	2024-12-03T06:56:42Z
InputId	string	The ID of the input.	SEGK5KA6KYKAWQQH
InputInfos	array<object>	The input configurations.
	object
FlowId	string	The ID of the flow from MediaConnect.	****81-9693-40dc-bbab-db5e49****
SourceUrl	string	The source URL from which the stream is pulled. Returned only for PULL inputs.	rtmp://domain/app/stream
StreamName	string	The name of the pushed stream. Returned only for PUSH inputs.	mystream
MonitorUrl	string	The URL for input monitoring.	rtmp://domain/app/stream_for_monitor
SrtPassphrase	string	The password for SRT stream encryption.	srtencryption
SrtMaxBitrate	integer	The maximum bitrate of the SRT stream, in bps.	3000000
FlowOutputName	string	The output name of the MediaConnect flow.	myFlowOutputName
SrtLatency	integer	The latency of the SRT stream, in milliseconds.	1000
DestHost	string	The endpoint to which the stream is pushed. Returned only for PUSH inputs.	rtmp://domain/app/stream
SrtPbKeyLen	integer	The key length for SRT stream encryption.	16
SecurityGroupIds	array	The IDs of the security groups associated with the input.
	string	The ID of the security group.	SEGK5KA6KYKAWQQH
ChannelIds	array	The IDs of the channels associated with the input.
	string	The ID of the channel.	SEGK5KA6KYKAWQQH
Name	string	The name of the input.	myinput
MaxResults	integer	The number of entries returned per page.	10
NextToken	string	A pagination token for retrieving the next page of results.	caeba0bbb2be03f84eb48b699f0a4883
TotalCount	integer	The total number of entries returned.	200

Examples

Success response

JSON format

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "Inputs": [
    {
      "Type": "RTMP_PUSH",
      "CreateTime": "2024-12-03T06:56:42Z",
      "InputId": "SEGK5KA6KYKAWQQH",
      "InputInfos": [
        {
          "FlowId": "******81-9693-40dc-bbab-db5e49******",
          "SourceUrl": "rtmp://domain/app/stream",
          "StreamName": "mystream",
          "MonitorUrl": "rtmp://domain/app/stream_for_monitor",
          "SrtPassphrase": "srtencryption",
          "SrtMaxBitrate": 3000000,
          "FlowOutputName": "myFlowOutputName",
          "SrtLatency": 1000,
          "DestHost": "rtmp://domain/app/stream",
          "SrtPbKeyLen": 16
        }
      ],
      "SecurityGroupIds": [
        "SEGK5KA6KYKAWQQH"
      ],
      "ChannelIds": [
        "SEGK5KA6KYKAWQQH"
      ],
      "Name": "myinput"
    }
  ],
  "MaxResults": 10,
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "TotalCount": 200
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.