查看域名--慢直播-火山引擎

文档中心

立即注册

导航

查看域名

最近更新时间：2022.02.08 14:17:35首次发布时间：2021.11.25 17:20:53

查询空间内指定域名的详细信息。

请求方式

使用 GET 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考「公共参数」。

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	GetSpaceDomain
Version	Query	String	是	公共参数，OpenAPI 接口版本	2021-01-01
SpaceID	Query	String	是	空间 ID	可通过调用 ListSpaces 接口获取
Domain	Query	String	是	域名名称	可通过调用 ListSpaceDomians 接口获取

返回结果

返回参数说明

通用返回参数，请参考 ResponseMetadata 结构体说明。

Result 字段包含以下参数：

字段	类型	说明
Domain	String	域名名称
Type	String	域名类型： rtmp-pull rtmp-push hdl-play hls-play webrtc-play
Status	String	域名状态： enabled（可用） disabled（停用）
CNAME	String	CNAME
Default	Boolean	是否为默认域名： true（是） false（否）
CreatedAt	Timestamp	域名创建时间
UpdatedAt	Timestamp	域名更新时间
TimeFlag	Boolean	是否开始时间戳防盗链： true（已开启） false（未开启）
MainKey	String	防盗链主 Key
SpareKey	String	防盗链备用 Key
ValidDuration	Integer	防盗链过期时间，单位为秒
Https	Array of objects	HTTPS 配置项，参考以下 HTTPS 数据结构说明

HTTPS 数据结构说明

字段	类型	说明
Enable	Boolean	HTTPS 功能配置状态： true（已开启） false（未开启）
CertificateID	String	与域名绑定的证书

字段

类型

说明

Enable

Boolean

HTTPS 功能配置状态：

true（已开启）
false（未开启）

CertificateID

String

与域名绑定的证书

示例

请求示例

GET https://open.volcengineapi.com?Action=GetSpaceDomain
&Version=2021-01-01
&SpaceID=517ff7ec-7700-4862-b1e7-7967a4xxxxxx
&Domain=prcldt8wqxxxxxx.pull.xxxxxx.com
&<公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202112081113280102121640220A012513",
        "Action": "GetSpaceDomain",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "Domain": "prcldt8wqxxxxxx.pull.xxxxxx.com",
        "Type": "fcdn-pull",
        "Status": "enabled",
        "CNAME": "prcldt8wqxxxxxx.pull.xxxxxx.com.c.xxxxxx.com",
        "Default": true,
        "Https": {
            "Enable": false,
            "CertificateID": ""
        },
        "CreatedAt": "2021-11-11T11:28:28+08:00",
        "UpdatedAt": "",
        "TimeFlag": true,
        "MainKey": "5a719103790e43cbade65d1689xxxxxx",
        "SpareKey": "ee614c9e8eb64997ac7b496a06xxxxxx",
        "ValidDuration": 0
    }
}