DescribeLiveUserDomains API リファレンス - LIVE

ご利用の Alibaba Cloud アカウントにおける ApsaraVideo Live のドメイン名を照会します。

操作説明

注意事項

この操作を呼び出すことで、ご利用の Alibaba Cloud アカウント内の ApsaraVideo Live のすべてのドメイン名を照会できます。サポートされているドメイン名のタイプは、ストリーミングドメインとエッジアップストリーミングドメインです。

QPS 制限

この操作は、アカウントあたり毎秒 100 回まで呼び出すことができます。この制限を超えたリクエストはドロップされ、サービスが中断されることがあります。この操作を呼び出す際は、この制限に注意することを推奨します。詳細については、「QPS 制限」をご参照ください。

今すぐお試しください

この 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:DescribeLiveUserDomains

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
LiveDomainType	string	任意	ドメイン名のタイプ。有効な値： liveVideo：ストリーミングドメイン liveEdge：アップストリーミングドメイン説明このパラメーターを空のままにすると、デフォルトでは、ご利用の Alibaba Cloud アカウント内のすべてのアップストリーミングドメインとストリーミングドメインが照会されます。	liveVideo
PageSize	integer	任意	1 ページあたりのエントリー数。デフォルト値：20。最大値：50。	20
PageNumber	integer	任意	ページ番号。有効な値：1～100000。	1
DomainName	string	任意	ドメイン名をフィルタリングするためのキーワードとなるドメイン名。あいまい一致をサポートしています。説明 LiveDomainType を liveEdge に設定し、このパラメーターを空のままにすると、アップストリーミングドメインが照会されます。	*.aliyundoc.com
RegionName	string	任意	ドメイン名が属するリージョンの ID。	cn-beijing
DomainSearchType	string	任意	検索モード。有効な値： fuzzy_match (デフォルト)：あいまい一致 pre_match：前方一致 suf_match：後方一致 full_match：完全一致	fuzzy_match
DomainStatus	string	任意	ドメイン名のステータス。有効な値： online offline configuring	online
Tag	array<object>	任意	タグ。
	object	任意	タグのリスト。
Key	string	任意	タグのキー。	TestKey
Value	string	任意	タグの値。	TestValue
ResourceGroupId	string	任意	リソースグループの ID。	rg-aek2egyoep3jp7a

レスポンスフィールド

フィールド	型	説明	例
	object
Domains	object
PageData	array<object>	ドメイン名。
	object	ドメイン名に関する情報。
Cname	string	ドメイン名に対して生成された CNAME ドメイン名。	learn.developer.aliyundoc.com
Description	string	説明。	test
DomainName	string	ドメイン名。	demo.aliyundoc.com
GmtCreated	string	ドメイン名が作成された時刻。時刻は、yyyy-MM-ddTHH:mm:ssZ 形式の ISO 8601 標準に準拠しています。時刻は UTC で表示されます。	2017-08-29T12:15:36Z
GmtModified	string	ドメイン名が最後に変更された時刻。時刻は、yyyy-MM-ddTHH:mm:ssZ 形式の ISO 8601 標準に準拠しています。時刻は UTC で表示されます。	2017-12-29T12:15:36Z
LiveDomainStatus	string	ドメイン名のステータス。有効な値は次のとおりです： online offline configuring	online
LiveDomainType	string	ドメイン名のタイプ。有効な値は次のとおりです： liveVideo：ストリーミングドメイン liveEdge：アップストリーミングドメイン	liveVideo
RegionName	string	ドメイン名が存在するリージョンの ID。	cn-beijing
ResourceGroupId	string	リソースグループの ID。	rg-aekzvyjetyjjmla
PageNumber	integer	ページ番号。	1
PageSize	integer	1 ページあたりのエントリ数。	100
RequestId	string	リクエストの ID。	E4EBD2BF-5EB0-4476-8829-9D94E1B15267
TotalCount	integer	エントリの総数。	1

例

成功レスポンス

JSONJSON

{
  "Domains": {
    "PageData": [
      {
        "Cname": "learn.developer.aliyundoc.com",
        "Description": "test",
        "DomainName": "demo.aliyundoc.com",
        "GmtCreated": "2017-08-29T12:15:36Z",
        "GmtModified": "2017-12-29T12:15:36Z",
        "LiveDomainStatus": "online",
        "LiveDomainType": "liveVideo",
        "RegionName": "cn-beijing",
        "ResourceGroupId": "rg-**kzvyjetyjjm**"
      }
    ]
  },
  "PageNumber": 1,
  "PageSize": 100,
  "RequestId": "E4EBD2BF-5EB0-4476-8829-9D94E1B15267",
  "TotalCount": 1
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidPageNumber.ValueNotSupported	The specified value of parameter PageNumber is not supported.
400	InvalidPageSize.ValueNotSupported	The specified value of parameter PageSize is not supported.
400	InvalidDomainStatus.ValueNotSupported	The specified value of parameter DomainStatus is not supported.
400	InvalidDomainName.Malformed	The specific value of parameter DomainName is malformed.
400	InvalidDomainSearchType.ValueNotSupported	The specified value of parameter DomainSearchType is not supported.
400	InvalidDomainSearchType.Malformed	he specified value of parameter DomainSearchType is invalid.
400	InvalidLiveDomainType.ValueNotSupported	The specified value of parameter LiveDomainType is not supported.

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

変更履歴

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