GetMediaConnectFlowOutput

更新时间:
复制 MD 格式

Retrieves the details of a specific output of a MediaConnect flow.

Operation description

  • If the specified flow instance ID does not exist, an error is returned.

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

create

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

FlowId

string

Yes

The flow ID.

0381f478-7d53-4076-9d5f-27680a6f73e7

OutputName

string

Yes

The name of the output that you want to query.

AliTestOutput

Response elements

Element

Type

Description

Example

object

The response content.

Content

object

The response body.

OutputName

string

The output name.

AliTestInput

OutputProtocol

string

The output type.

Valid values:

  • RTMP-PUSH

  • SRT-Caller

  • RTMP-PULL

  • SRT-Listener

  • Flow

Valid values:

  • RTMP-PUSH :

    RTMP-PUSH

  • SRT-Caller :

    SRT-Caller

  • RTMP-PULL :

    RTMP-PULL

  • SRT-Listener :

    SRT-Listener

  • Flow :

    Flow

SRT-PULL

Cidrs

string

The IP address whitelist in CIDR format. CIDR blocks are separated with commas (,).

10.211.0.0/17

OutputUrl

string

The output URL.

srt://1.2.3.4:1025

SrtLatency

integer

The SRT stream latency, in milliseconds. This parameter is returned when the source type is SRT-Listener or SRT-Caller.

1000

SrtPassphrase

string

The SRT encryption key. This parameter is returned when the source type is SRT-Listener or SRT-Caller.

FICUBPX4Q77DYHRF

SrtPbkeyLen

integer

The encryption key length. This parameter is returned when the source type is SRT-Listener or SRT-Caller.

Valid values:

  • 0

  • 16

  • 24

  • 32

Valid values:

  • 0 :

    0

  • 16 :

    16

  • 24 :

    24

  • 32 :

    32

32

PairFlowId

string

The destination flow ID. This parameter is returned when the output type is Flow.

805fbdd0-575e-4146-b35d-ec7f63937b20

PairInputName

string

The input name of the destination flow. This parameter is returned when the output type is Flow.

AliTestInput

PlayerLimit

integer

The maximum number of viewers.

5

CreateTime

string

The time when the flow was created.

2024-07-18T01:29:24Z

Forbid

string

Whether the output is disabled. Valid values: yes or no.

no

Description

string

The call description.

OK

RetCode

integer

The error code. A value of 0 indicates a successful call.

0

RequestId

string

The request ID.

0DB23DCE-0D69-598B-AA7C-7268D55E2F89

Examples

Success response

JSON format

{
  "Content": {
    "OutputName": "AliTestInput",
    "OutputProtocol": "SRT-PULL",
    "Cidrs": "10.211.0.0/17",
    "OutputUrl": "srt://1.2.3.4:1025",
    "SrtLatency": 1000,
    "SrtPassphrase": "FICUBPX4Q77DYHRF",
    "SrtPbkeyLen": 32,
    "PairFlowId": "805fbdd0-575e-4146-b35d-ec7f63937b20",
    "PairInputName": "AliTestInput",
    "PlayerLimit": 5,
    "CreateTime": "2024-07-18T01:29:24Z",
    "Forbid": "no"
  },
  "Description": "OK",
  "RetCode": 0,
  "RequestId": "0DB23DCE-0D69-598B-AA7C-7268D55E2F89"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.