DescribeLiveDomainDetail - 获取指定直播域名配置的基本信息

查询指定推流域名或播流域名的基本配置信息。

接口说明

本接口支持查询指定推流域名或播流域名的基本配置信息。 如果是新增域名的查询,域名配置完成需要一定时间,分钟级别,完全配置成功后可支持查询。

QPS 限制

本接口的单用户 QPS 限制为 50 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
live:DescribeLiveDomainDetailget
  • 全部资源
    *

请求参数

名称类型必填描述示例值
DomainNamestring

直播推流域名或播流域名。

demo.aliyundoc.com

返回参数

名称类型描述示例值
object
DomainDetailobject

域名配置详情。

CertNamestring

证书名称。

liveCert****
Cnamestring

CNAME 域名。为直播域名生成一个 CNAME 域名,需要在域名解析服务商处将直播域名 CNAME 解析到该域名。

说明 由于 Local DNS 的解析记录存在缓存时间,因此在配置域名的 CNAME 解析记录之后大约会延迟 10 分钟才会显示 CNAME 解析记录配置成功。详细内容,请参见 CNAME 解析常见问题
learn.developer.aliyundoc.com
Descriptionstring

域名备注,说明信息。

test
DomainNamestring

直播推流域名或播流域名。

demo.aliyundoc.com
DomainStatusstring

直播域名运行状态。取值:

  • online:启用。
  • offline:停用。
  • configuring:配置中。
online
GmtCreatedstring

创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2018-07-27T06:51:25Z
GmtModifiedstring

最近修改时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2018-08-07T06:51Z
LiveDomainTypestring

域名业务类型。取值:

  • liveVideo:播流域名。
  • liveEdge:边缘推流域名。
liveVideo
Regionstring

域名所属地域。

cn-shanghai
SSLProtocolstring

是否开启 SSL 证书。取值:

  • on:开启。
  • off:关闭。
on
SSLPubstring

证书公钥。

Public Key
Scopestring

加速区域。取值:

  • domestic:中国内地。
  • overseas:海外及港澳台加速。
  • global:全球加速。
domestic
ResourceGroupIdstring

资源组 ID。

rg-**k3bpq2yjw22**
RequestIdstring

请求 ID。

09ABE829-6CD3-4FE0-AFEE-556113E29727

示例

正常返回示例

JSON格式

{
  "DomainDetail": {
    "CertName": "liveCert****",
    "Cname": "learn.developer.aliyundoc.com",
    "Description": "test",
    "DomainName": "demo.aliyundoc.com",
    "DomainStatus": "online",
    "GmtCreated": "2018-07-27T06:51:25Z",
    "GmtModified": "2018-08-07T06:51Z",
    "LiveDomainType": "liveVideo",
    "Region": "cn-shanghai",
    "SSLProtocol": "on",
    "SSLPub": "Public Key",
    "Scope": "domestic",
    "ResourceGroupId": "rg-**k3bpq2yjw22**"
  },
  "RequestId": "09ABE829-6CD3-4FE0-AFEE-556113E29727"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-09-27OpenAPI 描述信息更新查看变更详情
2024-09-25OpenAPI 返回结构发生变更查看变更详情