GetAllCustomTemplates-阿里云帮助中心

Operation description

You can call this operation to retrieve all custom stream mix templates. The operation returns a list of template names and template configurations.

QPS limit

The queries per second (QPS) limit for a single user is 10 calls per second. If this limit is exceeded, throttling is triggered, which may affect your business. We recommend that you are aware of this limit when you call this operation.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
UserId	string	No	The user ID.	25346073170691****

Response elements

Element	Type	Description	Example
	object
CustomTemplates	string	A list of template names and template configurations.	[{"templateConfig": "{\"cdesc\":\"H264\",\"scale\":\"[3:4]\",\"gop\":\"1\",\"bframes\":\"1\",\"height\":\"1080\"}","templateName": "custom1"},{"templateConfig": "{\"ar\":\"44100\",\"cdesc\":\"H264\",\"scale\":\"[3:4]\",\"gop\":\"1\",\"bframes\":\"1\",\"height\":\"1080\"}","templateName": "cus"}]
RequestId	string	The request ID.	4791648Q-813C-6254-865C-0ED913661230

Examples

Success response

JSON format

{
  "CustomTemplates": " [{\"templateConfig\": \"{\\\"cdesc\\\":\\\"H264\\\",\\\"scale\\\":\\\"[3:4]\\\",\\\"gop\\\":\\\"1\\\",\\\"bframes\\\":\\\"1\\\",\\\"height\\\":\\\"1080\\\"}\",\"templateName\": \"custom1\"},{\"templateConfig\": \"{\\\"ar\\\":\\\"44100\\\",\\\"cdesc\\\":\\\"H264\\\",\\\"scale\\\":\\\"[3:4]\\\",\\\"gop\\\":\\\"1\\\",\\\"bframes\\\":\\\"1\\\",\\\"height\\\":\\\"1080\\\"}\",\"templateName\": \"cus\"}]",
  "RequestId": "4791648Q-813C-6254-865C-0ED913661230"
}

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	InvalidParameter.Malformed	There are invalid parameters: %s.	There are invalid parameters: %s.
400	MissingParameter	%s.	Missing parameter
400	CustomTemplateInvalid	%s, please check and try again later.	The custom template is invalid, please check and try again.
500	InternalError	%s, please try again later.	Internal error, please try again later.
404	InvalidDomainName.NotFound	%s, please check and try again later.	Domain name does not exist, please check and try again.

See for a complete list.

Release notes

See Release Notes for a complete list.