Skip to Content
云分发 UCDN批量获取加速域名配置 - GetUcdnDomainConfig

批量获取加速域名配置 - GetUcdnDomainConfig

简介

批量获取加速域名配置

定义

公共参数

参数名类型描述信息必填
Actionstring对应的 API 指令名称，当前 API 为 GetUcdnDomainConfigYes
PublicKeystring用户公钥，可从 控制台  获取Yes
Signaturestring根据公钥及 API 指令生成的用户签名，参见 签名算法Yes

请求参数

参数名类型描述信息必填
ProjectIdstring项目ID。不填写为默认项目，子帐号必须填写。 请参考GetProjectList接口No
Offsetint数据偏移量，默认0，非负整数No
Limitint返回数据长度， 默认全部，非负整数No
DomainId.Nstring域名id，创建域名时生成的id。默认获取账号下的所有域名信息,n为自然数,从DomainId.0开始。No
ChannelTypestring产品类型ucdn，可不填，默认为ucdnNo
Domain.Nstring域名No
IsDcdnboolean是否是动态加速 默认是falseNo

响应字段

字段名类型描述信息必填
RetCodeint返回状态码，为 0 则为成功返回，非 0 为失败Yes
Actionstring操作指令名称Yes
Messagestring返回错误消息，当 RetCode 非 0 时提供详细的描述信息No
DomainListarray[DomainConfigInfo]获取的域名信息，具体参考下面DomainConfigYes

数据模型

DomainConfigInfo

字段名类型描述信息必填
AreaCodestring查询带宽区域 cn代表国内 abroad代表海外 all表示全部区域Yes
CdnTypestring加速域名的业务类型，web代表网站，stream代表视频 ，download 代表下载Yes
Statusstring创建的加速域名的当前的状态。
check代表审核中；
checkSuccess代表审核通过；
checkFail代表审核失败；
enable代表加速中；
disable代表停止加速；
delete代表删除加速；
enableing代表正在开启加速；
disableing代表正在停止加速中；
deleteing代表删除中；
deploying代表部署中		Yes
Cnamestringcdn域名。创建加速域名生成的cdn域名，用于设置CNAME记录Yes
CreateTimeint域名创建的时间。格式：时间戳Yes
TestUrlstring测试url。用于域名创建加速时的测试Yes
HttpsStatusCnstring国内https状态 enableing-开启中 fail-开启失败 enable-启用 disable-未启用Yes
HttpsStatusAbroadstring国外https状态 enableing-开启中 fail-开启失败 enable-启用 disable-未启用Yes
CertNameCnstring国内证书名称Yes
CertNameAbroadstring国外证书名称Yes
Tagstring业务组：DefaultYes
DomainIdstring域名IdNo
Domainstring域名No
OriginConfOriginConf源站配置 参考OriginConfNo
AccessControlConfAccessControlConf访问控制配置 参考AccessControlConfNo
CacheConfCacheAllConfig缓存配置 参考CacheAllConfigNo
AdvancedConfAdvancedConf高级配置 参考AdvancedConfNo

OriginConf

字段名类型描述信息必填
OriginIpListarray[string]源站ip即cdn服务器回源访问的ip地址。多个源站ip，可以这样表述，如：[“1.1.1.1”,“2.2.2.2”]No
OriginHoststring回源Http请求头部Host，默认是加速域名No
OriginPortint回源端口No
BackupOriginEnableboolean1如果为false表示BackupOriginIp为空，表示没有备份源站，忽略BackupOriginIp，BackupOriginHost字段
2如果为true表示BackupOriginIp.n必须至少有一个备份源站地址
No
BackupOriginIpListarray[string]备份源站ip即cdn服务器回源访问的ip地址。多个源站ip，可以这样表述，如：[“1.1.1.1”,“2.2.2.2”]No
BackupOriginHoststring备份回源Http请求头部Host，默认是加速域名No
OriginErrorCodestring主源响应的回源错误码（如：404|500），默认空字符串No
OriginErrorNumint回主源的回源失败数，默认1No
OriginProtocolstring源站协议http，http|https 默认httpNo
OriginFollow301int跟随301跳转 0=不跟随 1=跟随No

AccessControlConf

字段名类型描述信息必填
IpBlackListarray[string]ip黑名单，多个ip，可表示为：
IpBlackList.0=1.1.1.1，IpBlackList.1=2.2.2.2		No
ReferConfReferConfrefer配置No

CacheAllConfig

字段名类型描述信息必填
CacheHoststring缓存Host，不同的域名可以配置为同一个CacheHost来实现缓存共享，默认为加速域名No
CacheListarray[CacheConf]缓存配置列表，参见CacheConfNo
HttpCodeCacheListarray[CacheConf]状态码缓存配置列表，参见CacheConfNo
CacheKeyListarray[CacheKeyInfo]忽略参数缓存配置列表，参见CacheKeyInfoNo

AdvancedConf

字段名类型描述信息必填
HttpClientHeaderarray[string]客户端响应http头列表No
HttpOriginHeaderarray[string]源站http头列表No
Http2Httpsbooleanhttp转https回源 true是，false否No
WebSocketEnableboolean是否开启websocketNo
QuicEnableboolean是否开启quicNo

CacheConf

字段名类型描述信息必填
PathPatternstring路径模式，支持正则Yes
CacheTTLint缓存时间Yes
CacheUnitstring缓存时间的单位。sec（秒），min（分钟），hour（小时），day（天）。上限1年。Yes
CacheBehaviorboolean是否缓存，true为缓存，flase为不缓存。为flase的情况下，CacheTTL和CacheUnit强制不生效Yes
HttpCodePatternstring状态码模式，非200，206状态码，多个状态码用竖线(|)分隔，该属性仅仅在状态码缓存配置列表中返回No
Descriptionstring缓存规则描述No
FollowOriginRuleboolean是否优先遵循源站头部缓存策略，false为不优先遵循源站，true为优先遵循源站缓存头部。默认为0No

CacheKeyInfo

字段名类型描述信息必填
Ignoreboolean是否忽略No
PathPatternstring路径模式，支持正则No
QueryStringstring自定义变量,以$符号开头，多个变量用加号(+)连接，$querystring表示所有变量No

ReferConf

字段名类型描述信息必填
ReferTypeintRefer防盗链配置 0白名单，1黑名单No
NullReferintReferType为白名单时（删除），NullRefer为0代表不允许NULL refer访问，为1代表允许Null refer访问No
ReferListarray[string]Refer防盗链规则列表，支持正则表达式No

示例

请求示例

http://api.spark.ucloud.cn/?Action= GetUcdnDomainConfig
& DomainId.0=domain-0331qd
&ChannelType=sdVTSYmK
&Domain.n=AhjiGKwI
&IsDcdn=false

响应示例

{
  "Action": " GetUcdnDomainConfigResponse",
  "DomainList": [
    {
      "AccessConf": {
        "IpBlackList": [
          "2.2.2.2",
          "3.3.3.3"
        ],
        "ReferConf": {
          "NullRefer": 0,
          "ReferList": [
            "www.baidu.com",
            "www.ucloud.com"
          ],
          "ReferType": 0
        }
      },
      "AdvancedConf": {
        "Http2Https": true,
        "HttpClientHeader": [
          "Access-Control-Allow-Origin:*",
          "Access-Control-Request-Method:GET"
        ],
        "HttpOriginHeader": [
          "Access-Control-Allow-Origin:*",
          "Access-Control-Request-Method:GET"
        ]
      },
      "AreaCode": "cn",
      "CacheConf": {
        "CacheHost": "share.ucloud.cn",
        "CacheList": [
          {
            "CacheBehavior": true,
            "CacheTTL": 12,
            "CacheUnit": "hour",
            "Description": "网站首页",
            "FollowOriginRule": false,
            "IgnoreQueryString": true,
            "PathPattern": "/"
          },
          {
            "CacheBehavior": true,
            "CacheTTL": 12,
            "CacheUnit": "hour",
            "Description": "所有文件",
            "FollowOriginRule": false,
            "IgnoreQueryString": true,
            "PathPattern": "/*.*"
          }
        ]
      },
      "CdnType": "web",
      "CertName": "ucloud_2019",
      "Cname": "9sqlhpr2.cdn.ucloud.cn",
      "CreateTime": 1392974921,
      "Domain": "abc.ucloud.cn",
      "DomainId": "domain-0331qd",
      "HttpsStatusAbroad": "enable",
      "HttpsStatusCn": "enable",
      "OriginConf": {
        "OriginFollow301": 0,
        "OriginHost": "www.xx.com",
        "OriginIpList": [
          "1.1.1.1",
          "2.2.2.2"
        ],
        "OriginPort": 80,
        "OriginProtocol": "http"
      },
      "Status": "enable",
      "Tag": "Default",
      "TestUrl": "http://static.ucloud.cn/logogg.jpg"
    }
  ],
  "RetCode": 0
}
获取域名带宽数据【新】 - GetUcdnDomainBandwidthV2获取域名命中率(新） - GetUcdnDomainHitRate