全部文档
当前文档

暂无内容

如果没有找到您期望的内容,请尝试其他搜索词

文档中心

查询域名配置

最近更新时间:2024-03-27 15:08:35

查询域名配置(GetLiveDomainConfigs)

接口描述

  • 用于获取指定域名的基本信息,一次只能提交一个域名

  • 调用方式:HTTP GET

  • 签名机制

    • Service取值:cdn

  • 接入地址:cdn.api.ksyun.com︎

注意:

  • 该推拉流域名必须已备案完成

请求参数

参数名

类型

是否必须

描述

DomainName

String

Y

域名名称

ConfigList

String

N

"basicInfo", "originConfig", "ipProtectionConfig", "certificateConfig", "timestampAuthConfig", "liveNotifyConfig" 任选,逗号分隔,不传为全部

返回参数

参数名

类型

描述

UniqueName

String

域名空间

DomainName

String

域名名称

DomainId

String

域名ID

Cname

String

域名对应的CNAME

DomainStatus

String

域名运行状态

IcpRegistration

String

ICP备案号

AuditFailReason

String

审核失败原因

LiveDomainType

String

域名类型,取值 push:推流域名;pull:拉流域名

CdnProtocol

String

域名协议,当LiveDomainType=pull时,取值范围为rtmp,hdl;当LiveDomainType=push时,取值范围为rtmp

Regions

String

计费区域,多个以逗号间隔

OriginType

String

源站类型,取值:ipaddr、domain、ksvideo分别表示:IP源站、域名源站、金山云视频云源站

OriginProtocol

String

回源协议:rtmp,hdl

Origin

String

回源地址,可以是IP或域名;IP支持最多20个,以逗号区分;域名只能输入一个,IP与域名不能同时输入

CreatedTime

String

域名创建时间,ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如:2016-08-01T21:14+0800

ModifiedTime

String

域名修改时间,ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如:2016-08-01T21:14+0800

UserNotify

String

根据相应业务返回相应参数

UserPublishUrl

String

根据相应业务返回相应参数

UserPublishDoneUrl

String

根据相应业务返回相应参数

请求示例

GET /?Action=GetLiveDomainConfigs&Version=2016-09-01&DomainName=xxx.xxxxx.com&ConfigList=xxx
Content-Type: application/json
X-Amz-Date: YOURDATE
Authorization: authorization string
Host: cdn.api.ksyun.com

返回示例

{
    "UniqueName": "xxx",
    "DomainName": "xxx.xxx.com",
    "BasicInfo": {
        "DomainId": "2D0506B",
        "IcpRegistration": "京ICP备12032080号-2",
        "LiveDomainType": "push",
        "CdnProtocol": "rtmp",
        "Cname": "tc16.ksyun.com.upvcloud.ks-cdn.com",
        "DomainStatus": "online",
        "CreatedTime": "2024-02-28T17:14+0800",
        "ModifiedTime": "2024-02-28T18:01+0800"
    },
    "OriginConfig": [
        {
            "OriginType": "ksvideo",
            "Port": 1935,
            "OriginProtocol": "rtmp",
            "BackOriginHost": "tc16.ksyun.com"
        }
    ],
    "IpProtectionConfig": {
        "Enable": "on",
        "IpType": "allow",
        "IpList": "1.1.1.1,2.2.2.2"
    },
    "CertificateConfig": {},
    "TimestampAuthConfig": {
        "Enable": "on",
        "Timestamp": "tctime",
        "MD5Name": "tcmd5",
        "Key": [
            "zzz0816",
            "ttt0816"
        ],
        "ExpirationTime": 700,
        "MD5Hash": "SecretKey|ExpirationTime|URI",
        "MD5SumRangeStart": 2,
        "MD5SumRangeEnd": 19,
        "TimestampFormat": "HEX"
    },
    "LiveNotifyConfig": {
        "UserNotify": "off",
        "UserPublishUrl": "",
        "UserPublishDoneUrl": ""
    }
}

错误码

此接口为CDN接口,请到使用须知查看错误码详情。

文档导读
纯净模式常规模式

纯净模式

点击可全屏预览文档内容
文档反馈