> For the complete documentation index, see [llms.txt](https://docs.console.zenlayer.com/api-reference/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.console.zenlayer.com/api-reference/cn/cdn/datastructure.md).

# 数据结构

## ProtocolValue

回源协议类型。

| 类型    | 类型说明    |
| ----- | ------- |
| HTTP  | http协议  |
| HTTPS | https协议 |

## PurgeTypeValue

缓存刷新任务类型。

| 类型        | 类型说明 |
| --------- | ---- |
| FILE      | 文件刷新 |
| DIRECTORY | 目录刷新 |

## PurgeStatusValue

刷新、预热状态。

| 状态值        | 状态说明 |
| ---------- | ---- |
| Success    | 成功   |
| InProgress | 进行中  |
| Failed     | 失败   |

## DomainStatusValue

加速域名状态。

| 状态值      | 状态说明 |
| -------- | ---- |
| ENABLED  | 启用中  |
| DISABLED | 已停用  |

## ConfigStatusValue

加速域名配置状态。

| 状态值       | 状态说明 |
| --------- | ---- |
| DEPLOYED  | 部署成功 |
| DEPLOYING | 部署中  |
| FAILED    | 部署失败 |

## AccessControlType

访问控制类型。

| 类型    | 类型说明 |
| ----- | ---- |
| WHITE | 白名单  |
| BLACK | 黑名单  |

## UrlAclActionType

url访问控制操作类型。

| 类型     | 类型说明 |
| ------ | ---- |
| BLOCK  | 封禁   |
| RESUME | 恢复   |

## CacheType

缓存类型。

| 类型             | 类型说明   |
| -------------- | ------ |
| FILE           | 文件缓存   |
| DIRECTORY      | 目录缓存   |
| ALL\_WEBSITE   | 全站缓存   |
| SPECIFIC\_FILE | 指定文件缓存 |

## CacheTimeType

缓存时间类型。

| 类型      | 类型说明 |
| ------- | ---- |
| SECONDS | 秒    |
| MINUTE  | 分    |
| HOUR    | 时    |
| DAY     | 天    |

## PurgeResultInfo

刷新、预热结果信息

| 名称         | 类型     | 必选 | 描述                                       |
| ---------- | ------ | -- | ---------------------------------------- |
| path       | String | 是  | 刷新、预热路径                                  |
| status     | String | 是  | 刷新、预热状态，取值范围见[刷新预热状态](#purgestatusvalue) |
| createTime | String | 是  | 刷新、预热任务创建时间                              |
| updateTime | String | 是  | 刷新、预热任务完成时间                              |

## LogInfo

加速域名日志信息

| 名称          | 类型     | 必选 | 描述       |
| ----------- | ------ | -- | -------- |
| size        | String | 是  | 日志文件大小   |
| duration    | String | 是  | 日志文件时间   |
| downloadUrl | String | 是  | 日志文件下载地址 |

## DomainInfo

加速域名信息

| 名称              | 类型        | 必选 | 描述                                                                                                                                                                                                      |
| --------------- | --------- | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| domainId        | String    | 是  | 加速域名Id                                                                                                                                                                                                  |
| businessType    | String    | 是  | 业务类型，取值范围见[业务类型](#businesstype)                                                                                                                                                                         |
| domainName      | String    | 是  | 加速域名名称                                                                                                                                                                                                  |
| domainStatus    | String    | 是  | 加速域名状态，取值范围见[加速域名状态](#domainstatusvalue)                                                                                                                                                                |
| cname           | String    | 是  | 加速域名CNAME                                                                                                                                                                                               |
| createTime      | Timestamp | 是  | <p>加速域名创建时间</p><p>按照<code>ISO8601</code>标准表示，并且使用<code>UTC</code>时间。格式为：<code>YYYY-MM-DDThh</code><span data-gb-custom-inline data-tag="emoji" data-code="1f1f2-1f1f2">🇲🇲</span><code>ssZ。</code></p> |
| resourceGroupId | String    | 是  | 加速域名所属资源组的ID                                                                                                                                                                                            |

## Origin

加速域名的源站信息

| 名称              | 类型                            | 必选 | 描述                                                                             |
| --------------- | ----------------------------- | -- | ------------------------------------------------------------------------------ |
| masterSource    | String                        | 是  | <p>主源站</p><ul><li>源站为域名时不能与加速域名相同，且只能配置一个</li><li>源站为ip时支持配置多个，以逗号分隔</li></ul> |
| slaverSource    | String                        | 否  | <p>备源站</p><ul><li>源站为域名时不能与加速域名相同，且只能配置一个</li><li>源站为ip时支持配置多个，以逗号分隔</li></ul> |
| originPort      | String                        | 否  | http回源端口                                                                       |
| originPortHttps | String                        | 否  | https回源端口                                                                      |
| s3SourceConfig  | [S3SourceInfo](#s3sourceinfo) | 否  | <p>S3源站配置</p><p>当配置AWS S3源时，masterSource必须填写为S3源站地址</p><p>其他字段无须配置（不生效）</p>    |

## S3SourceInfo

S3源站配置

| 名称        | 类型     | 必选 | 描述                        |
| --------- | ------ | -- | ------------------------- |
| accessKey | String | 是  | 用于访问S3的Access Key         |
| secretKey | String | 是  | 用于访问S3，与Access Key配套使用的密钥 |
| region    | String | 是  | S3 存储桶所在区域                |

## BillingRegion

计费大区信息

| 名称         | 类型     | 必选 | 描述      |
| ---------- | ------ | -- | ------- |
| regionId   | String | 是  | 计费大区缩写。 |
| regionName | String | 是  | 计费大区名称。 |

## AnalysisRegion

计费大区信息

| 名称        | 类型              | 必选 | 描述   |
| --------- | --------------- | -- | ---- |
| continent | String          | 是  | 大洲。  |
| countries | Array of String | 是  | 国家地区 |

## GeoRegion

国家/地区列表

| 名称         | 类型     | 必选 | 描述       |
| ---------- | ------ | -- | -------- |
| regionId   | String | 是  | 国家/地区缩写。 |
| regionName | String | 是  | 国家/地区名称。 |

## AccelerationRegion

加速域名的加速区域信息

| 名称         | 类型     | 必选 | 描述                          |
| ---------- | ------ | -- | --------------------------- |
| regionId   | String | 是  | <p>加速区域ID。<br>例如：Global</p> |
| regionName | String | 是  | 加速区域的名称。                    |

## BusinessType

加速域名的业务类型信息

| 名称               | 类型     | 必选 | 描述                                         |
| ---------------- | ------ | -- | ------------------------------------------ |
| businessTypeId   | String | 是  | <p>业务类型ID。<br>例如：LargeFileAcceleration</p> |
| businessTypeName | String | 是  | 业务类型名称。                                    |

## CacheInfo

加速域名的缓存配置

| 名称        | 类型      | 必选 | 描述                                   |
| --------- | ------- | -- | ------------------------------------ |
| cacheId   | String  | 否  | 缓存id                                 |
| cacheType | String  | 是  | 缓存类型，取值范围见[缓存类型](#cachetype)         |
| cacheTime | Integer | 是  | 缓存时间                                 |
| timeUnit  | String  | 是  | 缓存时间类型，取值范围见[缓存时间类型](#cachetimetype) |
| priority  | Integer | 是  | 缓存优先级                                |
| content   | String  | 是  | 缓存内容                                 |
| directory | String  | 是  | 缓存目录                                 |

## IpAclInfo

加速域名的ip访问控制配置

| 名称     | 类型              | 必选 | 描述                                         |
| ------ | --------------- | -- | ------------------------------------------ |
| enable | Boolean         | 是  | 是否开启ip访问控制                                 |
| type   | String          | 是  | ip访问控制类型，取值范围见[访问控制类型](#accesscontroltype) |
| ips    | Array of String | 否  | ip列表。                                      |

## UaAclInfo

加速域名的ua访问控制配置

| 名称     | 类型              | 必选 | 描述                        |
| ------ | --------------- | -- | ------------------------- |
| enable | Boolean         | 是  | 是否开启ua访问控制                |
| uas    | Array of String | 否  | <p>ua列表</p><p>支持正则表达式</p> |

## UrlAclInfo

加速域名的url访问控制配置

| 名称     | 类型      | 必选 | 描述                                         |
| ------ | ------- | -- | ------------------------------------------ |
| action | Boolean | 是  | 操作类型，取值范围见[url访问控制操作类型](#urlaclactiontype) |
| uri    | String  | 是  | 需要封禁/恢复的uri                                |

## RefererAclInfo

加速域名的referer访问控制配置

| 名称                | 类型              | 必选 | 描述                                              |
| ----------------- | --------------- | -- | ----------------------------------------------- |
| enable            | Boolean         | 是  | 是否开启referer访问控制                                 |
| type              | String          | 是  | referer访问控制类型，取值范围见[访问控制类型](#accesscontroltype) |
| allowEmptyReferer | Boolean         | 是  | 是否允许空referer。                                   |
| allowNoReferer    | Boolean         | 是  | 是否允许没有referer。                                  |
| refererDomains    | Array of String | 否  | referer域名列表。                                    |

## GeoAclInfo

加速域名的geographic访问控制配置

| 名称      | 类型              | 必选 | 描述                                          |
| ------- | --------------- | -- | ------------------------------------------- |
| enable  | Boolean         | 是  | 是否开启geo访问控制                                 |
| type    | String          | 是  | geo访问控制类型，取值范围见[访问控制类型](#accesscontroltype) |
| regions | Array of String | 否  | geo区域列表。                                    |

## OriginPathRewriteInfo

加速域名的回源路径重写配置

| 名称         | 类型      | 必选 | 描述                                    |
| ---------- | ------- | -- | ------------------------------------- |
| sourcePath | String  | 是  | 请求路径的正则，长度不能超过1024个字符，用于匹配用户请求URL中的路径 |
| targetPath | String  | 是  | 表示改写后的回源路径                            |
| sort       | Integer | 是  | 优先级，值越小优先级越高                          |

## SliceInfo

加速域名的切片配置

| 名称     | 类型      | 必选 | 描述        |
| ------ | ------- | -- | --------- |
| enable | Boolean | 是  | 是否开启切片    |
| size   | Integer | 否  | 切片大小，byte |

## GzipInfo

加速域名的gzip压缩配置

| 名称     | 类型      | 必选 | 描述         |
| ------ | ------- | -- | ---------- |
| enable | Boolean | 是  | 是否开启gzip压缩 |

## IgnoreQueryStringInfo

加速域名的去问号缓存配置

| 名称     | 类型      | 必选 | 描述        |
| ------ | ------- | -- | --------- |
| enable | Boolean | 是  | 是否开启去问号缓存 |

## HttpToHttpsInfo

加速域名的http强转https配置

| 名称     | 类型      | 必选 | 描述              |
| ------ | ------- | -- | --------------- |
| enable | Boolean | 是  | 是否开启http强转https |

## SpeedLimitInfo

加速域名的限速配置

| 名称     | 类型      | 必选 | 描述         |
| ------ | ------- | -- | ---------- |
| enable | Boolean | 是  | 是否开启限速     |
| limit  | Integer | 否  | 限速值，byte/s |

## TimeData

时间分割数据

| 名称    | 类型     | 必选 | 描述    |
| ----- | ------ | -- | ----- |
| time  | String | 是  | 分割时间点 |
| value | Double | 是  | 数据    |

## BandwithData

cdn带宽、流量数据

| 名称      | 类型                                 | 必选 | 描述       |
| ------- | ---------------------------------- | -- | -------- |
| region  | String                             | 否  | 计费大区     |
| country | String                             | 否  | 国家       |
| domain  | String                             | 否  | 加速域名     |
| data    | Array of [TimeDataInfo](#timedata) | 是  | 带宽、流量结果集 |

## BandwithQueryCondition

cdn带宽、流量查询条件

| 名称        | 类型     | 必选 | 描述     |
| --------- | ------ | -- | ------ |
| startTime | String | 是  | 查询开始时间 |
| endTime   | String | 否  | 查询结束时间 |
| region    | String | 否  | 计费大区   |
| protocol  | String | 否  | 协议类型   |
| domain    | String | 否  | 加速域名   |
| group     | String | 否  | 分组类型   |

## StatusCodeDetailData

cdn状态码明细

| 名称    | 类型      | 必选 | 描述   |
| ----- | ------- | -- | ---- |
| code  | String  | 是  | 状态码  |
| count | Integer | 是  | 统计次数 |

## StatusCodeData

cdn状态码数据

| 名称     | 类型                                                     | 必选 | 描述    |
| ------ | ------------------------------------------------------ | -- | ----- |
| domain | String                                                 | 否  | 加速域名  |
| detail | Array of [StatusCodeDetailData](#statuscodedetaildata) | 是  | 状态码明细 |

## HitRateData

cdn命中率

| 名称     | 类型                                 | 必选 | 描述     |
| ------ | ---------------------------------- | -- | ------ |
| domain | String                             | 否  | 加速域名   |
| data   | Array of [TimeDataInfo](#timedata) | 是  | 命中率结果集 |

## RankingBandwithData

带宽排行数据

| 名称           | 类型      | 必选 | 描述          |
| ------------ | ------- | -- | ----------- |
| domain       | String  | 是  | 加速域名        |
| maxbandwidth | Double  | 是  | 带宽峰值，单位Mbps |
| requests     | Integer | 是  | 峰值请求数       |
| traffic      | Double  | 是  | 峰值流量，单位MB   |
| time         | String  | 是  | 峰值时间        |

## RankingIpData

ip排行数据

| 名称      | 类型      | 必选 | 描述       |
| ------- | ------- | -- | -------- |
| ip      | String  | 是  | 访问ip     |
| isp     | String  | 是  | 运营商      |
| count   | Integer | 是  | 总次数      |
| traffic | Double  | 是  | 总流量，单位MB |

## RankingUrlData

url排行数据

| 名称      | 类型      | 必选 | 描述       |
| ------- | ------- | -- | -------- |
| url     | String  | 是  | 请求url    |
| count   | Integer | 是  | 总次数      |
| traffic | Double  | 是  | 总流量，单位MB |

## RankingRefererData

referer排行数据

| 名称      | 类型      | 必选 | 描述       |
| ------- | ------- | -- | -------- |
| referer | String  | 是  | referer  |
| count   | Integer | 是  | 总次数      |
| traffic | Double  | 是  | 总流量，单位MB |

## RankingUvData

uv排行数据

| 名称      | 类型      | 必选 | 描述       |
| ------- | ------- | -- | -------- |
| domain  | String  | 是  | 加速域名     |
| count   | Integer | 是  | 总次数      |
| traffic | Double  | 是  | 总流量，单位MB |

## VisitData

page view/unique visitor数据

| 名称      | 类型      | 必选 | 描述      |
| ------- | ------- | -- | ------- |
| time    | String  | 是  | 时间      |
| count   | Integer | 是  | 次数      |
| traffic | Double  | 是  | 流量，单位MB |

## CertificateInfo

证书信息

| 名称               | 类型              | 必选 | 描述                                                                                                                                                                                                    |
| ---------------- | --------------- | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| certificateId    | String          | 否  | <p>证书Id</p><p>因兼容老的证书上传形式，<code>DescribeAccelerators</code>返回此字段可能为空</p>                                                                                                                              |
| certificateLabel | String          | 是  | 自定义证书标签                                                                                                                                                                                               |
| common           | String          | 是  | 证书主域名                                                                                                                                                                                                 |
| fingerprint      | String          | 是  | md5证书指纹                                                                                                                                                                                               |
| issuer           | String          | 是  | 证书颁发机构                                                                                                                                                                                                |
| sans             | Array of String | 是  | 主题备用名称                                                                                                                                                                                                |
| algorithm        | String          | 是  | 加密算法                                                                                                                                                                                                  |
| createTime       | Timestamp       | 是  | <p>证书创建时间</p><p>按照<code>ISO8601</code>标准表示，并且使用<code>UTC</code>时间。格式为：<code>YYYY-MM-DDThh</code><span data-gb-custom-inline data-tag="emoji" data-code="1f1f2-1f1f2">🇲🇲</span><code>ssZ。</code></p> |
| startTime        | Timestamp       | 是  | <p>证书开始时间</p><p>按照<code>ISO8601</code>标准表示，并且使用<code>UTC</code>时间。格式为：<code>YYYY-MM-DDThh</code><span data-gb-custom-inline data-tag="emoji" data-code="1f1f2-1f1f2">🇲🇲</span><code>ssZ。</code></p> |
| endTime          | Timestamp       | 是  | <p>证书过期时间</p><p>按照<code>ISO8601</code>标准表示，并且使用<code>UTC</code>时间。格式为：<code>YYYY-MM-DDThh</code><span data-gb-custom-inline data-tag="emoji" data-code="1f1f2-1f1f2">🇲🇲</span><code>ssZ。</code></p> |
| expired          | Boolean         | 是  | 证书是否过期                                                                                                                                                                                                |
| resourceGroupId  | String          | 否  | <p>实例所属资源组的ID</p><p><code>DescribeAccelerators</code>不返回此字段</p>                                                                                                                                       |

## OnlineStreamInfo

在线流信息

| 名称            | 类型      | 必选 | 描述                                                                                                                            |
| ------------- | ------- | -- | ----------------------------------------------------------------------------------------------------------------------------- |
| domainName    | String  | 否  | 推流域名                                                                                                                          |
| appName       | String  | 否  | 应用名                                                                                                                           |
| streamName    | String  | 否  | 流名                                                                                                                            |
| publishTime   | String  | 否  | <p>开始推流的时间（UTC 时间）</p><p>yyyy-MM-ddTHH<span data-gb-custom-inline data-tag="emoji" data-code="1f1f2-1f1f2">🇲🇲</span>ssZ</p> |
| clientIp      | String  | 否  | 推流客户端IP                                                                                                                       |
| width         | Integer | 否  | 视频分辨率宽度                                                                                                                       |
| height        | Integer | 否  | 视频分辨率高度                                                                                                                       |
| videoCodec    | String  | 否  | 视频编码                                                                                                                          |
| audioCodec    | String  | 否  | 音频编码                                                                                                                          |
| videoDataRate | Double  | 否  | 视频码率                                                                                                                          |
| audioDataRate | Double  | 否  | 音频码率                                                                                                                          |
| frameRate     | Integer | 否  | 视频帧率                                                                                                                          |

## BlockStreamInfo

流禁播信息

| 名称        | 类型     | 必选 | 描述                                                                                                                           |
| --------- | ------ | -- | ---------------------------------------------------------------------------------------------------------------------------- |
| streamUrl | String | 否  | 禁播url                                                                                                                        |
| expiredAt | String | 否  | <p>禁播到期时间（UTC 时间）</p><p>yyyy-MM-ddTHH<span data-gb-custom-inline data-tag="emoji" data-code="1f1f2-1f1f2">🇲🇲</span>ssZ</p> |