ModifyAppRecordTemplate-阿里云帮助中心

Modify an application recording template.

Operation description

QPS limit

This API supports up to 10 calls per second per user. If you exceed this limit, rate limiting is triggered, which might affect your service. Call the API at a reasonable frequency.

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

rtc:ModifyAppRecordTemplate

none

*App

acs:rtc:*:{#accountId}:app/{#AppId}

None

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	Idempotency parameter.	53200b81-b761-4c10-842a-a0726d97xxxx
RecordTemplate	object	Yes	Recording template.
Name	string	Yes	Template name.	模版
FilePrefix	string	Yes	The naming convention for recording files. Note To ensure unique recording file names, use the following naming convention: `record/{AppId}/{ChannelId}/{TaskId}/{EscapedStartTime}/{EscapedEndTime}`.	record/{AppId}/{ChannelId}_{TaskId}/{EscapedStartTime}_{EscapedEndTime}
FileSplitInterval	integer	Yes	Recording file split duration (greater than or equal to 1800). Unit: seconds.	1800
DelayStopTime	integer	No	Delayed stop recording time. Unit: seconds.	180
MediaEncode	integer	Yes	Encoding options.	1
Formats	array	Yes	Recording file format. Currently, only .m3u8, .mp4, and .flv are supported.
	string	No	Recording file format.	mp4
LayoutIds	array	Yes	Layout ID list, up to 16. Note: The layouts in the list must not have the same number of data sources.
	string	No	Specific layout ID.	2
TemplateId	string	Yes	Template ID.	2xh6****
AppId	string	Yes	Application ID. Create and query through the console. Only a single ID is supported.	ac7N****

The MediaEncode enumeration values are listed in the following table.

ID	Width	Height	Bitrate (Kbps)	Frame rate (FPS)	Notes
0	0	0	64	0	Audio-only
1	640	360	500	15
10	960	540	700	24
20	1280	720	1024	24
22	720	1280	1024	30
23	800	600	1024	30
24	750	780	1024	30
25	750	540	700	30
26	720	1280	2048	30
27	1280	720	2048	30
28	1280	720	3096	30
30	1920	1080	2048	30
31	1080	1920	2048	30
32	1024	768	1024	24
33	1280	960	1024	24
34	1024	768	2048	24
35	1280	960	2048	24
36	1280	720	1024	24
37	1280	720	2048	24
38	540	960	750	15
39	540	960	1500	30
40	1280	720	1200	15
41	720	1280	1200	15
42	720	1280	1500	15
43	540	960	1200	15
52	640	360	500	30
53	360	640	500	15
54	360	640	500	30
60	1920	1080	4096	30
61	1080	1920	4096	30

Response elements

Element	Type	Description	Example
	object	Response schema
RequestId	string	Request ID	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

Examples

Success response

JSON format

{
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ParameterError	%s.
400	Function.Disable	%s.	Function status is invalid, please request in function enabled state.
400	Quota.Invalid	%s.	Resource quota is insufficient, please submit a work order to increase the quota
404	NotFound	%s.	The requested resource does not exist

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.