DescribeLiveAIStudio - - Alibaba Cloud Documentation Center

Queries the virtual studio templates within your Alibaba Cloud account.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
StudioId	string	No	The ID of the virtual studio template that you want to query. This parameter is optional.	dbe61b87-db9a-448f-8757-a875edb3f944
StudioName	string	No	The name of the virtual studio template.	sub02
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Valid values: 1 to 50.	10

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
Total	integer	The total number of templates.	100
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page. Default value: 10. Valid values: 1 to 50.	10
StudioConfigs	array<object>	The virtual studio templates.
SubtitleConfig	object	The information about the virtual studio template.
MediaType	string	The type of the multimedia material. Valid values: VOD: a video in ApsaraVideo VOD PIC: an image LIVE: a live stream	VOD
MediaLayout	string	LIVE, live streaming	"{\"positionY\":\"0.0\",\"positionX\":\"0.0\",\"heightNormalized\":\"0.5\"}"
MediaResourceUrl	string	The URL of the multimedia material.	https://testbucket.xx.com/2.jpg
MediaResourceId	string	The ID of the multimedia material in ApsaraVideo VOD.	d0eb493192c771efba644531858c0102
BackgroundType	string	The type of the background material. Valid values: VOD: a video in ApsaraVideo VOD PIC: an image LIVE: a live stream	VOD
BackgroundResourceUrl	string	The URL of the background material. Make sure that the URL is accessible over the Internet. Either this parameter or the BackgroundResourceId parameter is returned.	https://testbucket.xx.com/2.jpg
BackgroundResourceId	string	The ID of the background material.	d0eb493192c771efba644531858c0102
Description	string	The custom description.	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. The name is the same as the value of the StudioName parameter that was specified when you called the CreateLiveAiStudio operation to create the virtual studio template.	studio1
MattingLayout	string	The layout information of the multimedia material.	"{\"positionY\":\"0.0\",\"positionX\":\"0.0\",\"heightNormalized\":\"0.5\"}"
MattingType	string	The type of chroma key that is performed on ingested streams. Valid values: green: green-key chroma key blue: blue-screen chroma key complex: background replacement	complex
Height	string	The preview height. Unit: pixels. The following preview specifications (width × height) are supported: 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 preview width.	1920
RuleIds	array	The IDs of the bound rules.
ruleId	string	The ID of the rule.	2414378f-541a-48d3-be0c-535212f9a6b4

Examples

Sample success responses

JSONformat

{
  "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

For a list of error codes, visit the Service error codes.