DescribeLiveAIStudio で AI Studio テンプレートをクエリする - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

アカウント内のバーチャルスタジオテンプレートの一覧を照会します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

live:DescribeLiveAIStudio

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	リージョン ID です。	cn-shanghai
StudioId	string	任意	フィルターするテンプレートの ID です。このパラメーターは任意です。	dbe61b87-db9a-448f-8757-a875edb3f944
StudioName	string	任意	仮想スタジオテンプレートの名前です。	sub02
PageNumber	integer	任意	現在のページ番号です。デフォルト値は 1 です。	1
PageSize	integer	任意	各ページに返すエントリ数です。デフォルト値は 10 です。有効な値は 1～50 です。	10

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンススキーマ。
RequestId	string	リクエスト ID。	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
Total	integer	テンプレートの総数。	100
PageNumber	integer	現在のページ番号。	1
PageSize	integer	各ページに返されるエントリ数。デフォルト値：10。有効な値：1～50。	10
StudioConfigs	object
SubtitleConfig	array<object>	仮想スタジオテンプレートの情報。
	array<object>	仮想スタジオテンプレートの情報。
MediaType	string	メディアアセットのタイプ。有効な値：VOD、PIC、LIVE。 VOD：ビデオオンデマンドファイル。 PIC：画像。 LIVE：ライブストリーム。	VOD
MediaLayout	string	メディアアセットのレイアウト情報。	"{\"positionY\":\"0.0\",\"positionX\":\"0.0\",\"heightNormalized\":\"0.5\"}"
MediaResourceUrl	string	メディアアセットの URL。	https://testbucket.xx.com/2.jpg
MediaResourceId	string	メディアアセットの VOD リソース ID。	d0eb493192c771efba644531858c0102
BackgroundType	string	背景素材のタイプ。有効な値：VOD、PIC、LIVE。 VOD：ビデオオンデマンドファイル。 PIC：画像。 LIVE：ライブストリーム。	VOD
BackgroundResourceUrl	string	背景素材のパブリック URL。 URL はインターネット経由でアクセスできる必要があります。このパラメーターまたは `BackgroundResourceId` のいずれかを指定します。	https://testbucket.xx.com/2.jpg
BackgroundResourceId	string	背景素材リソースの ID。	d0eb493192c771efba644531858c0102
Description	string	仮想スタジオテンプレートの説明。	user defined description
TemplateId	string	仮想スタジオテンプレートの ID。	24654384-f5ac-40ea-823b-74e85a61dd9f
TemplateName	string	仮想スタジオテンプレートの名前。このパラメーターは、AddLiveAiStudio 操作の `StudioName` パラメーターと同じです。	studio1
MattingLayout	string	キーイングされたポートレートのレイアウト。	"{\"positionY\":\"0.0\",\"positionX\":\"0.0\",\"heightNormalized\":\"0.5\"}"
MattingType	string	ソースストリームのクロマキータイプ。取り込んだストリームの処理に使用します。 green：グリーンスクリーンを背景にした人物のクロマキー。 blue：ブルースクリーンを背景にした人物のクロマキー。 complex：実世界の背景に対する人物のクロマキー。	complex
Height	string	プレビュー画像の高さ (ピクセル単位)。プレビュー画像の解像度 (幅 × 高さ) は、次のいずれかである必要があります。横向き低画質 (360p)：640 × 360 縦向き低画質 (360p)：360 × 640 横向き標準画質 (480p)：854 × 480 縦向き標準画質 (480p)：480 × 854 横向き高画質 (720p)：1280 × 720 縦向き高画質 (720p)：720 × 1280 横向き超高画質 (1080p)：1920 × 1080 縦向き超高画質 (1080p)：1080 × 1920	1080
Width	string	プレビュー画像の幅。	1920
RuleIds	object
ruleId	array	ルール ID の配列。
	string	ルール ID。	2414378f-541a-48d3-be0c-535212f9a6b4

例

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	LiveServiceNotFound	%s, please check and try again later.
400	InvalidParameter.PurchaseTime	%s, please check and try again later.
400	InvalidParameter.ExpireTime	%s, please check and try again later.
400	MissingParameter	%s.
400	InvalidChargeType.Malformed	%s, please check and try again later.
400	InvalidChargeType.PostSupport	%s, please check and try again later.
400	InvalidCasterTemplate.Malformed	%s, please check and try again later.
400	InvalidParameter.Malformed	There are invalid parameters: %s.
400	InvalidParameter.ChargeType	%s, please check and try again later.
400	InvalidPeriod.Malformed	%s, please check and try again later.
400	InvalidUserId.Malformed	%s, please check userId.
400	InvalidClientToken.Malformed	%s, please check and try again later.
400	IncorrectCasterStatus	%s, please check and try again later.
401	CasterNumberExceed	%s, please check and try again later.
403	PermissionDenied	%s, please check and try again later.
404	InvalidParameter.NormType	%s, please check and try again later.
404	InvalidConfiguration.NotFound	%s, please check and try again later.
408	DescribeLiveAIStudio.Timeout	%s, please try again later.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。