DescribeLiveAIStudio - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the virtual studio templates in your account.

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

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
StudioId	string	No	The ID of the template to filter. This parameter is optional.	dbe61b87-db9a-448f-8757-a875edb3f944
StudioName	string	No	The name of the virtual studio template.	sub02
PageNumber	integer	No	The current page number. The default value is 1.	1
PageSize	integer	No	The number of entries to return on each page. Default value: 10. Valid values: 1 to 50.	10

Response parameters

Parameter	Type	Description	Example
	object	The response schema.
RequestId	string	The ID of the request.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
Total	integer	The total number of templates.	100
PageNumber	integer	The current page number.	1
PageSize	integer	The number of entries returned on each page. Default value: 10. Valid values: 1 to 50.	10
StudioConfigs	object
SubtitleConfig	array<object>	The information about the virtual studio template.
	object	The information about the virtual studio template.
MediaType	string	The type of the media asset. Valid values: VOD, PIC, and LIVE. VOD: a video-on-demand file. PIC: an image. LIVE: a live stream.	VOD
MediaLayout	string	The layout information of the media asset.	"{\"positionY\":\"0.0\",\"positionX\":\"0.0\",\"heightNormalized\":\"0.5\"}"
MediaResourceUrl	string	The URL of the media asset.	https://testbucket.xx.com/2.jpg
MediaResourceId	string	The ID of the VOD resource for the media asset.	d0eb493192c771efba644531858c0102
BackgroundType	string	The type of the background material. Valid values: VOD, PIC, and LIVE. VOD: a video-on-demand file. PIC: an image. LIVE: a live stream.	VOD
BackgroundResourceUrl	string	The public URL of the background material. The URL must be accessible over the Internet. Specify this parameter or `BackgroundResourceId`.	https://testbucket.xx.com/2.jpg
BackgroundResourceId	string	The ID of the background material resource.	d0eb493192c771efba644531858c0102
Description	string	The description of the virtual studio template.	user defined description
TemplateId	string	The ID of the virtual studio template.	24654384-f5ac-40ea-823b-74e85a61dd9f
TemplateName	string	The name of the virtual studio template. This parameter is the same as the `StudioName` parameter in the AddLiveAiStudio operation.	studio1
MattingLayout	string	The layout of the keyed-out portrait.	"{\"positionY\":\"0.0\",\"positionX\":\"0.0\",\"heightNormalized\":\"0.5\"}"
MattingType	string	The chroma keying type for the source stream. This is used to process the ingested stream. green: chroma keying for a portrait against a green screen background. blue: chroma keying for a portrait against a blue screen background. complex: chroma keying for a portrait against a real-world background.	complex
Height	string	The height of the preview image, in pixels. The resolution of the preview image (width × height) must be one of the following: Landscape low definition (360p): 640 × 360 Portrait low definition (360p): 360 × 640 Landscape standard definition (480p): 854 × 480 Portrait standard definition (480p): 480 × 854 Landscape high definition (720p): 1280 × 720 Portrait high definition (720p): 720 × 1280 Landscape ultra-high definition (1080p): 1920 × 1080 Portrait ultra-high definition (1080p): 1080 × 1920	1080
Width	string	The width of the preview image.	1920
RuleIds	object
ruleId	array	The rule IDs.
	string	The rule ID.	2414378f-541a-48d3-be0c-535212f9a6b4

Examples

Success response

JSON format

{
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
  "Total": 100,
  "PageNumber": 1,
  "PageSize": 10,
  "StudioConfigs": {
    "SubtitleConfig": [
      {
        "MediaType": "VOD",
        "MediaLayout": "\"{\\\"positionY\\\":\\\"0.0\\\",\\\"positionX\\\":\\\"0.0\\\",\\\"heightNormalized\\\":\\\"0.5\\\"}\"",
        "MediaResourceUrl": "https://testbucket.xx.com/2.jpg",
        "MediaResourceId": "\t\nd0eb493192c771efba644531858c0102\n",
        "BackgroundType": "VOD",
        "BackgroundResourceUrl": "https://testbucket.xx.com/2.jpg",
        "BackgroundResourceId": "d0eb493192c771efba644531858c0102",
        "Description": "user defined description",
        "TemplateId": "24654384-f5ac-40ea-823b-74e85a61dd9f",
        "TemplateName": "studio1",
        "MattingLayout": "\"{\\\"positionY\\\":\\\"0.0\\\",\\\"positionX\\\":\\\"0.0\\\",\\\"heightNormalized\\\":\\\"0.5\\\"}\"",
        "MattingType": "complex",
        "Height": "1080",
        "Width": "1920",
        "RuleIds": {
          "ruleId": [
            "2414378f-541a-48d3-be0c-535212f9a6b4"
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message
400	LiveServiceNotFound	%s
400	InvalidParameter.PurchaseTime	%s
400	InvalidParameter.ExpireTime	%s
400	MissingParameter	%s
400	InvalidChargeType.Malformed	%s
400	InvalidChargeType.PostSupport	%s
400	InvalidCasterTemplate.Malformed	%s
400	InvalidParameter.Malformed	%s
400	InvalidParameter.ChargeType	%s
400	InvalidPeriod.Malformed	%s
400	InvalidUserId.Malformed	%s
400	InvalidClientToken.Malformed	%s
400	IncorrectCasterStatus	%s
401	CasterNumberExceed	%s
403	PermissionDenied	%s
404	InvalidParameter.NormType	%s
404	InvalidConfiguration.NotFound	%s
408	DescribeLiveAIStudio.Timeout	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.