StartLiveStreamMonitor - ApsaraVideo Live - Alibaba Cloud Documentation Center

Operation description

You can call the CreateLiveStreamMonitor operation to create a monitoring session. Then, you can use the MonitorId value from the response to start the session.

QPS limits

The queries per second (QPS) limit for this operation is 10 calls per second for each user. Calls that exceed this limit are throttled. Throttling may affect your business. Plan your calls 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

live:StartLiveStreamMonitor

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
MonitorId	string	Yes	The ID of the monitoring session. Note Obtain the MonitorId value from the response of the CreateLiveStreamMonitor operation.	445409ec-7eaa-461d-8f29-4bec2eb9****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	5c6a2a0d-f228-4a64-af62-20e91b9676b3

Examples

Success response

JSON format

{
  "RequestId": "5c6a2a0d-f228-4a64-af62-20e91b9676b3"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidUserId.Malformed	%s, please check userId.	The userId passed in is invalid, please check.
400	InvalidMonitorId.Malformed	%s, please check and try again later.	The parameter MonitorId is invalid, please check and try again.
400	StreamMonitorAlreadyStarted	%s, please check and try again later.	The monitoring room has been opened, please check and try again.
401	IllegalOperation	%s, please check and try again later.	Operation not allowed, please check and try again.
500	InternalError	%s, please try again later.	Internal error, please try again later.
403	UserQuotaExceed	Quota exceeded: %s.	Quota exceeded: %s.
404	StreamMonitorNotExist	%s, please check and try again later.	The monitoring room does not exist, please check and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.