全部文档
当前文档

暂无内容

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

文档中心

查询直播域名列表

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

查询直播域名列表(GetLiveDomains)

接口描述

  • 用于查询当前用户下所有直播域名列表信息,包含加速域名、域名ID、域名运行状态、域名类型、CNAME域名、ICP备案号、域名创建时间、域名最近修改时间等

  • 支持按域名模糊匹配过滤、域名状态过滤

  • 支持根据域名运行状态、域名类型筛选查询

  • 调用方式:HTTP GET

  • 签名机制

    • Service取值:cdn

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

请求参数

参数名

类型

是否必须

描述

PageSize

Long

N

分页大小,默认20,最大500,取值1~500间整数

PageNumber

Long

N

取第几页,默认为1,取值1~10000

DomainName

String

N

按域名过滤,默认为空,代表当前用户下所有域名,域名长度最大255

DomainStatus

String

N

按域名状态过滤,默认为空,代表当前用户下全部域名状态,具体枚举类型表见使用须知

DomainType

String

N

按域名类型过滤,直播域名类型:push:推流、pull:拉流,默认为空,代表当前用户下全部直播域名类型

FuzzyMatch

String

N

域名过滤是否使用模糊匹配,取值为on:开启,off:关闭,默认为on

返回参数

参数名

类型

描述

PageNumber

Long

页码

PageSize

Long

单页大小

TotalCount

Long

总条数

Domains

Domain[]

Domain列表

Domian

参数名

类型

描述

DomainName

String

加速域名名称

DomainId

String

域名ID

Cname

String

加速域名对应的CNAME域名

DomainType

String

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

IcpRegistration

String

ICP备案号

DomainStatus

String

域名状态,
运行中 - online
已停止 - offline
配置中 - configuring
审核中 - icp_checking
审核失败 - icp_check_failed
已封禁 - locked
封禁中 - locking

CreatedTime

String

加速域名创建时间

ModifiedTime

String

加速域名最近修改时间

Description

String

审核失败原因

请求示例

GET /?Action=GetLiveDomains&Version=2016-09-01&PageSize=20&PageNumber=1&DomainName=xxx&DomainStatus=online&DomainType=xxx&FuzzyMatch=on HTTP/1.1
Content-Type: application/json
X-Amz-Date: YOURDATE
Authorization: authorization string
Host: cdn.api.ksyun.com

返回示例

{
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 4,
  "Domains": [
    {
      "DomainName":"xxx.xxxxx.com",
      "DomainId": "2D09RCM",
      "DomainType": "pull",
      "Description": "",
      "ModifiedTime": "2016-09-21T15:37+0800",
      "CreatedTime": "2016-09-21T15:37+0800",
      "IcpRegistration": "鄂ICP备15011961号-1",
      "Cname": "www.test.com.hdlvcloud.ks-cdn.com",
      "DomainStatus": "online"
    },
    {
      "DomainName":"xxx.xxxxx.com",
      "DomainId": "2D09RHJ",
      "DomainType": "push",
      "Description": "",
      "ModifiedTime": "2016-09-21T15:37+0800",
      "CreatedTime": "2016-09-21T15:37+0800",
      "IcpRegistration": "鄂ICP备15011987号-1",
      "Cname": "www.test2.com.hdlvcloud.ks-cdn.com",
      "DomainStatus": "online"
    },
    {
      "DomainName":"xxx.xxxxx.com",
      "DomainId": "2D09RYU",
      "DomainType": "pull",
      "Description": "",
      "ModifiedTime": "2016-09-21T15:37+0800",
      "CreatedTime": "2016-09-21T15:37+0800",
      "IcpRegistration": "鄂ICP备15010786号-1",
      "Cname": "www.test3.com.hdlvcloud.ks-cdn.com",
      "DomainStatus": "online"
    },
    {
      "DomainName":"xxx.xxxxx.com",
      "DomainId": "2D10HGJ",
      "DomainType": "pull",
      "Description": "",
      "ModifiedTime": "2016-09-21T15:37+0800",
      "CreatedTime": "2016-09-21T15:37+0800",
      "IcpRegistration": "鄂ICP备150195432号-1",
      "Cname": "www.test4.com.hdlvcloud.ks-cdn.com",
      "DomainStatus": "online"
    }
  ]
}

错误码

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

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

纯净模式

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