查询调度域名详情

更新时间:2023-08-03 12:32:44

适用产品

CDN Pro

接口描述

该接口返回调度域名的详细信息,包含相关的访客分区规则和调度域名的操作记录。如果您没有自定义访客分区规则,系统将创建一条默认的规则。

推荐使用 Open API在线调试

Open API在线调试功能提供可视化界面在线调试API、支持生成代码示例、快速检索查看API文档等能力。前往调试

请求参数

Path 参数

参数名称描述
*edgeHostnameString
调度域名。

返回参数

Body 参数

参数名称描述
historyList
调度域名的操作记录。
operationString
取值范围: creation,update 操作类型,即创建或更新。
timeString
操作时间,以RFC 3339日期格式表示。
apiRequestIdString
API请求的ID。
lastUpdateTimeString
RFC 3339格式的日期,表示调度域名最后一次更新的时间。
creationTimeString
RFC 3339格式的日期,表示调度域名的创建时间。
configsObject
调度域名的相关设置。
edgeHostnameString
调度域名。
pciRequiredBoolean
默认值: False 表示流量调度是否需要遵循PCI规范。当值为true时,表示只能使用已通过PCI认证的节点提供内容分发服务。
descriptionString
调度域名的描述。
hasBeianBoolean
默认值: False 是否备案的标记。当值为true时,将使用包括中国大陆的服务器提供内容分发服务。
clientZonesList
自定义规则来控制如何处理不同访客分区的请求。您必须至少创建一条覆盖所有区域和所有运营商的规则。
regionString
该规则适用的区域。可调用'查询支持的区域列表'接口来查看区域信息。例如,如果您希望创建规则覆盖整个欧洲,则指定'eu'为区域。 您可以指定具体的国家。例如,'na.us'代表'美国',而'eu.fr'代表'法国'。 'all'是一个特殊的区域,可用于指定适用于全球的规则。如果不同规则指定的区域存在重叠,则以更细粒度的区域优先。例如,如果您在一条规则中指定'as',在另一条规则中指定'as.cn',则来自中国的请求将优先匹配'as.cn'的规则。
weightInteger
默认值: 100 取值范围: [ 0 .. 100 ] 可以为同个访客分区指定多条规则。通过在规则中指定weight字段,可控制规则匹配的权重。 以'as.cn'区域的2条规则为例: {'region':'as.cn', 'isp':'all', 'action':{'type':'deliver', 'by':['standard', 'premium', 'deluxe']}}, {'region':'as.cn', 'isp':'all', 'action':{'type':'redirect', 'to':['alternate.cname.com']}, 'weight':10} 按照以上规则,客户端请求匹配规则1进行'分发'的比例为100/(100+10),即0.909,匹配规则2进行'跳转'的比例为10/(100+10),即0.091。
actionObject
当规则匹配时执行的动作。
typeString
取值范围: deliver,redirect,reject 当规则匹配时,对客户端请求执行的动作的类型。包括分发,拒绝和跳转3个类型。如果指定了'拒绝',则客户端请求将被调度到一台服务器,该服务器总是响应403状态码,表示'Forbidden'拒绝访问。每个访客分区最多只允许一个'拒绝'动作。
byList
如果动作类型为'分发',则使用此字段指定一个或多个节点组(standard, premium, deluxe, ultra, nearChina, ChinaStandard, ChinaPremium) 来选择提供内容分发服务的缓存节点。如果未指定,则使用'standard'。

'nearChina' 是一个特殊的节点组。如果您需要使用nearChina节点组,请联系我们的技术支持开通。不能在同一条规则中同时指定nearChina节点组和其他节点组。如果要使用其他节点组,需要创建单独的访客分区规则。

如果您的加速域名有ICP备案,希望由中国大陆的服务器提供内容分发服务,您可以选择使用'ChinaStandard'和'ChinaPremium'节点组。

如果调度域名创建时没有指定使用ChinaStandard或ChinaPremium节点组,则无法通过更新调度域名来使用这两个节点组。您需要创建一个新的调度域名,在新的调度域名中指定使用ChinaStandard或ChinaPremium,才能使用这2个节点组。
toList
如果动作类型为'跳转',则通过该字段指定跳转的目标域名或IP地址。'跳转'目标通常是源站服务器或其它CDN厂商。
enableIPv6Boolean
默认值: True 指定是否允许使用IPv6地址进行内容分发。仅当动作类型为'分发'时该值才有效。
ispString
该规则适用的运营商。可调用我们的'查询支持的ISP运营商列表'接口查看运营商信息。指定'all'表示所有运营商。如果希望该规则应用于多个运营商,则可指定多个运营商,用逗号分隔,但最多只能包含10个运营商。
estimatedBandwidthString
通过该调度域名进行CDN加速预计需要的带宽。单位应为Tbps、Gbps、Mbps或kbps。示例:100 Gbps。

错误码

错误代码(code)描述(message)HTTP状态码语义
InvalidEdgeHostnameThe specified edge hostname does not exist or the caller doesn't have access to this resource.404指定的调度域名不存在,或者您无访问权限。

示例

200
404
200
请求示例
复制代码 复制成功
#!/bin/bash
username="example_username"
apiKey="example_apiKey"
date=`env LANG="en_US.UTF-8" date -u "+%a, %d %b %Y %H:%M:%S GMT"`
password=`echo -en "$date" | openssl dgst -sha1 -hmac $apiKey -binary | openssl enc -base64`
curl -i --url "https://open.chinanetcenter.com/cdn/edgeHostnames/{edgeHostname}" \
-X "GET" \
-u "$username:$password" \
-H "Date: $date" \
-H "Accept: application/json"
返回示例
复制代码 复制成功
{
    "configs": {
        "edgeHostname": "rtycno8odxuwycaror3f.qtlcdn.com",
        "hasBeian": false,
        "clientZones": [
            {
                "region": "all",
                "action": {
                    "type": "deliver",
                    "by": [
                        "standard"
                    ],
                    "enableIPv6": true
                },
                "isp": "all",
                "weight": 100
            }
        ]
    },
    "creationTime": "2020-05-30T00:43:49Z",
    "lastUpdateTime": "2020-05-30T00:43:49Z",
    "history": [
        {
            "operation": "creation",
            "time": "2020-05-30T00:43:49Z",
            "apiRequestId": "b46c1a060706c4e9"
        }
    ]
}
本篇文档内容对您是否有帮助?
有帮助
我要反馈
提交成功!非常感谢您的反馈,我们会继续努力做到更好!