全部產品
Search
文件中心

ApsaraVideo Live:DescribeLiveUserDomains - 查詢使用者名稱下所有的直播網域名稱

更新時間:Dec 13, 2025

查詢使用者名稱下所有的直播網域名稱。

介面說明

本介面目前支援的直播網域名稱業務類型為播流網域名稱和邊緣推流網域名稱。

QPS 限制

本介面的單使用者 QPS 限制為 100 次/秒。超過限制,API 呼叫會被限流,這可能會影響您的業務,請合理調用。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

live:DescribeLiveUserDomains

get

*全部資源

*

請求參數

名稱

類型

必填

描述

樣本值

LiveDomainType

string

直播網域名稱業務類型。取值:

  • liveVideo:播流網域名稱。

  • liveEdge:邊緣推流網域名稱。

說明

如果不設定此參數,則請求參數 DomainName 預設查詢使用者所有直播推流和播流網域名稱。

liveVideo

PageSize

integer

分頁大小。預設值為 20,最大值為 50

20

PageNumber

integer

當前頁碼。取值範圍:1~100000

1

DomainName

string

網域名稱模糊比對過濾。

說明
  • 如果 LiveDomainType(直播網域名稱業務類型)取值為 liveVideo,此參數不傳值時,預設查詢使用者播流網域名稱的相關資訊。- 如果 LiveDomainType(直播網域名稱業務類型)取值為 liveEdge,此參數不傳值時,預設查詢使用者推流網域名稱的相關資訊。

*.aliyundoc.com

RegionName

string

網域名稱所屬地區。

cn-beijing

DomainSearchType

string

網域名稱查詢類型。取值:

  • fuzzy_match(預設值):模糊比對。

  • pre_match:前匹配。

  • suf_match:後匹配。

  • full_match:完全符合。

fuzzy_match

DomainStatus

string

網域名稱狀態。取值:

  • online:運行中(表示網域名稱服務 (DNS)狀態正常)。

  • offline:已停止。

  • configuring:配置中。

online

Tag

array<object>

標籤列表。

object

標籤列表。

Key

string

標籤健。

TestKey

Value

string

標籤值。

TestValue

ResourceGroupId

string

資源群組 ID。

rg-**kzvyjetyjjm**

返回參數

名稱

類型

描述

樣本值

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(UTC 時間)。

2017-08-29T12:15:36Z

GmtModified

string

直播網域名稱修改時間。格式為:yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。

2017-12-29T12:15:36Z

LiveDomainStatus

string

網域名稱狀態。取值:

  • online:運行中(表示網域名稱服務 (DNS)狀態正常)。

  • offline:已停止。

  • configuring:配置中。

online

LiveDomainType

string

直播網域名稱業務類型。取值:

  • liveVideo:播流網域名稱。

  • liveEdge:邊緣推流網域名稱。

liveVideo

RegionName

string

網域名稱所屬地區。

cn-beijing

ResourceGroupId

string

資源群組 ID。

rg-**kzvyjetyjjm**

PageNumber

integer

返回資料的當前頁碼。

1

PageSize

integer

分頁大小。

100

RequestId

string

請求 ID。

E4EBD2BF-5EB0-4476-8829-9D94E1B15267

TotalCount

integer

總條數。

1

樣本

正常返回樣本

JSON格式

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

錯誤碼

錯誤資訊

描述

400 InvalidPageNumber.ValueNotSupported The specified value of parameter PageNumber is not supported. 指定的PageNumber參數的值不支援。
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.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情