> 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/networking/cdn/datastructure.md).

# Data Types

## ProtocolValue

Origin protocol types.

| Type  | Description    |
| ----- | -------------- |
| HTTP  | HTTP protocol  |
| HTTPS | HTTPS protocol |

## PurgeTypeValue

Cache purge task types.

| Type      | Description     |
| --------- | --------------- |
| FILE      | File purge      |
| DIRECTORY | Directory purge |

## PurgeStatusValue

Purge and prefetch statuses.

| Status Value | Description |
| ------------ | ----------- |
| Success      | Success     |
| InProgress   | In progress |
| Failed       | Failed      |

## DomainStatusValue

Acceleration domain status.

| Status Value | Description |
| ------------ | ----------- |
| ENABLED      | Enabled     |
| DISABLED     | Disabled    |

## ConfigStatusValue

Acceleration domain configuration status.

| Status Value | Description           |
| ------------ | --------------------- |
| DEPLOYED     | Deployment successful |
| DEPLOYING    | In deployment         |
| FAILED       | Deployment failed     |

## AccessControlType

Access control types.

| Type  | Description |
| ----- | ----------- |
| WHITE | Whitelist   |
| BLACK | Blacklist   |

## UrlAclActionType

URL access control action types.

| Type   | Description |
| ------ | ----------- |
| BLOCK  | Block       |
| RESUME | Resume      |

## CacheType

Cache types.

| Type           | Description         |
| -------------- | ------------------- |
| FILE           | File cache          |
| DIRECTORY      | Directory cache     |
| ALL\_WEBSITE   | Full site cache     |
| SPECIFIC\_FILE | Specific file cache |

## CacheTimeType

Cache time types.

| Type    | Description |
| ------- | ----------- |
| SECONDS | Seconds     |
| MINUTE  | Minutes     |
| HOUR    | Hours       |
| DAY     | Days        |

## PurgeResultInfo

Purge and prefetch result information.

| Name       | Type   | Required | Description                                                     |
| ---------- | ------ | -------- | --------------------------------------------------------------- |
| path       | String | Yes      | Purge or prefetch path                                          |
| status     | String | Yes      | Purge or prefetch status, see [Purge Status](#purgestatusvalue) |
| createTime | String | Yes      | Creation time of the purge or prefetch task                     |
| updateTime | String | Yes      | Completion time of the purge or prefetch task                   |

## LogInfo

Acceleration domain log information

| Name        | Type   | Required | Description                                   |
| ----------- | ------ | -------- | --------------------------------------------- |
| size        | String | Yes      | Log file size                                 |
| duration    | String | 是        | The time period to which the log file belongs |
| downloadUrl | String | 是        | Download address                              |

## DomainInfo

Acceleration domain information

| Name            | Type      | Required | Description                                                                                                                                                                         |
| --------------- | --------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| domainId        | String    | Yes      | Acceleration domain ID                                                                                                                                                              |
| businessType    | String    | Yes      | Business type, refer to [Business Type](#businesstype)                                                                                                                              |
| domainName      | String    | Yes      | Acceleration domain name                                                                                                                                                            |
| domainStatus    | String    | Yes      | Acceleration domain status, refer to [Domain Status](#domainstatusvalue)                                                                                                            |
| cname           | String    | Yes      | Acceleration domain CNAME                                                                                                                                                           |
| createTime      | Timestamp | Yes      | <p>Creation time of the acceleration domain</p><p>Formatted according to <code>ISO8601</code> standard, using <code>UTC</code> time. Format: <code>YYYY-MM-DDThh:mm:ssZ.</code></p> |
| resourceGroupId | String    | Yes      | ID of the resource group to which the acceleration domain belongs                                                                                                                   |

## Origin

Origin information of the acceleration domain

| Name            | Type                          | Required | Description                                                                                                                                                                                                                        |
| --------------- | ----------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| masterSource    | String                        | Yes      | <p>Primary origin</p><ul><li>If the origin is a domain, it cannot be the same as the acceleration domain, and only one can be configured</li><li>If the origin is an IP, multiple can be configured, separated by commas</li></ul> |
| slaverSource    | String                        | No       | <p>Backup origin</p><ul><li>If the origin is a domain, it cannot be the same as the acceleration domain, and only one can be configured</li><li>If the origin is an IP, multiple can be configured, separated by commas</li></ul>  |
| originPort      | String                        | No       | HTTP origin port                                                                                                                                                                                                                   |
| originPortHttps | String                        | No       | HTTPS origin port                                                                                                                                                                                                                  |
| s3SourceConfig  | [S3SourceInfo](#s3sourceinfo) | No       | S3 Origin                                                                                                                                                                                                                          |

## S3SourceInfo

S3 Origin of the acceleration domain

| Name      | Type   | Required | Description                               |
| --------- | ------ | -------- | ----------------------------------------- |
| accessKey | String | Yes      | Access Key used to access S3              |
| secretKey | String | Yes      | Secret Key paired with the Access Key     |
| region    | String | Yes      | The region where the S3 bucket is located |

## BillingRegion

Billing region information

| Name       | Type   | Required | Description                 |
| ---------- | ------ | -------- | --------------------------- |
| regionId   | String | Yes      | Billing region abbreviation |
| regionName | String | Yes      | Billing region name         |

## AnalysisRegion

Billing region information

| Name      | Type            | Required | Description           |
| --------- | --------------- | -------- | --------------------- |
| continent | String          | Yes      | Continent             |
| countries | Array of String | Yes      | Countries and regions |

## GeoRegion

Country/Region list

| Name       | Type   | Required | Description                 |
| ---------- | ------ | -------- | --------------------------- |
| regionId   | String | Yes      | Country/Region abbreviation |
| regionName | String | Yes      | Country/Region name         |

## AccelerationRegion

Acceleration region information for the domain

| Name       | Type   | Required | Description                                       |
| ---------- | ------ | -------- | ------------------------------------------------- |
| regionId   | String | Yes      | <p>Acceleration region ID.<br>Example: Global</p> |
| regionName | String | Yes      | Acceleration region name                          |

## BusinessType

Business type information for the domain

| Name             | Type   | Required | Description                                                |
| ---------------- | ------ | -------- | ---------------------------------------------------------- |
| businessTypeId   | String | Yes      | <p>Business type ID.<br>Example: LargeFileAcceleration</p> |
| businessTypeName | String | Yes      | Business type name                                         |

## CacheInfo

Cache configuration for the acceleration domain

| Name      | Type    | Required | Description                                                 |
| --------- | ------- | -------- | ----------------------------------------------------------- |
| cacheId   | String  | No       | Cache ID                                                    |
| cacheType | String  | Yes      | Cache type, refer to [Cache Type](#cachetype)               |
| cacheTime | Integer | Yes      | Cache time                                                  |
| timeUnit  | String  | Yes      | Cache time unit, refer to [Cache Time Type](#cachetimetype) |
| priority  | Integer | Yes      | Cache priority                                              |
| content   | String  | Yes      | Cache content                                               |
| directory | String  | Yes      | Cache directory                                             |

## IpAclInfo

IP access control configuration for the acceleration domain

| Name   | Type            | Required | Description                                                                |
| ------ | --------------- | -------- | -------------------------------------------------------------------------- |
| enable | Boolean         | Yes      | Whether IP access control is enabled                                       |
| type   | String          | Yes      | IP access control type, refer to [Access Control Type](#accesscontroltype) |
| ips    | Array of String | No       | List of IPs                                                                |

## UaAclInfo

UA access control configuration for the acceleration domain

| Name   | Type            | Required | Description                                           |
| ------ | --------------- | -------- | ----------------------------------------------------- |
| enable | Boolean         | Yes      | Whether UA access control is enabled                  |
| uas    | Array of String | No       | <p>List of UAs</p><p>Supports regular expressions</p> |

## UrlAclInfo

URL access control configuration for the acceleration domain

| Name   | Type    | Required | Description                                                               |
| ------ | ------- | -------- | ------------------------------------------------------------------------- |
| action | Boolean | Yes      | Action type, refer to [URL Access Control Action Type](#urlaclactiontype) |
| uri    | String  | Yes      | URI to be blocked/restored                                                |

## RefererAclInfo

Referer access control configuration for the acceleration domain

| Name              | Type            | Required | Description                                                                     |
| ----------------- | --------------- | -------- | ------------------------------------------------------------------------------- |
| enable            | Boolean         | Yes      | Whether referer access control is enabled                                       |
| type              | String          | Yes      | Referer access control type, refer to [Access Control Type](#accesscontroltype) |
| allowEmptyReferer | Boolean         | Yes      | Whether to allow empty referer                                                  |
| allowNoReferer    | Boolean         | Yes      | Whether to allow no referer                                                     |
| refererDomains    | Array of String | No       | List of referer domains                                                         |

## GeoAclInfo

Geographic access control configuration for the acceleration domain

| Name    | Type            | Required | Description                                                                 |
| ------- | --------------- | -------- | --------------------------------------------------------------------------- |
| enable  | Boolean         | Yes      | Whether geo access control is enabled                                       |
| type    | String          | Yes      | Geo access control type, refer to [Access Control Type](#accesscontroltype) |
| regions | Array of String | No       | List of geo regions                                                         |

## OriginPathRewriteInfo

URL Rewrite for the acceleration domain

| Name       | Type    | Required | Description                                                                                                               |
| ---------- | ------- | -------- | ------------------------------------------------------------------------------------------------------------------------- |
| sourcePath | String  | Yes      | Indicates a regular expression, with a maximum length of 1,024 characters, used to match the path in the user request URL |
| targetPath | String  | Yes      | Indicates the rewrite path, with a maximum length of 1,024 characters                                                     |
| sort       | Integer | Yes      | Sorting: the smaller the value, the higher the priority                                                                   |

## SliceInfo

Slice configuration for the acceleration domain

| Name   | Type    | Required | Description                |
| ------ | ------- | -------- | -------------------------- |
| enable | Boolean | Yes      | Whether slicing is enabled |
| size   | Integer | No       | Slice size in bytes        |

## GzipInfo

Gzip compression configuration for the acceleration domain

| Name   | Type    | Required | Description                         |
| ------ | ------- | -------- | ----------------------------------- |
| enable | Boolean | Yes      | Whether gzip compression is enabled |

## IgnoreQueryStringInfo

Query string ignore cache configuration for the acceleration domain

| Name   | Type    | Required | Description                                    |
| ------ | ------- | -------- | ---------------------------------------------- |
| enable | Boolean | Yes      | Whether query string ignoring cache is enabled |

## HttpToHttpsInfo

HTTP to HTTPS redirection configuration for the acceleration domain

| Name   | Type    | Required | Description                                  |
| ------ | ------- | -------- | -------------------------------------------- |
| enable | Boolean | Yes      | Whether HTTP to HTTPS redirection is enabled |

## SpeedLimitInfo

Speed limit configuration for the acceleration domain

| Name   | Type    | Required | Description                           |
| ------ | ------- | -------- | ------------------------------------- |
| enable | Boolean | Yes      | Whether speed limiting is enabled     |
| limit  | Integer | No       | Speed limit value in bytes per second |

## TimeData

Time-segmented data

| Name  | Type   | Required | Description             |
| ----- | ------ | -------- | ----------------------- |
| time  | String | Yes      | Segmentation time point |
| value | Double | Yes      | Data                    |

## BandwidthData

CDN bandwidth and traffic data

| Name    | Type                           | Required | Description                   |
| ------- | ------------------------------ | -------- | ----------------------------- |
| region  | String                         | No       | Billing region                |
| country | String                         | No       | Country                       |
| domain  | String                         | No       | Acceleration domain           |
| data    | Array of [TimeData](#timedata) | Yes      | Bandwidth and traffic dataset |

## BandwidthQueryCondition

CDN bandwidth and traffic query conditions

| Name      | Type   | Required | Description         |
| --------- | ------ | -------- | ------------------- |
| startTime | String | Yes      | Start time          |
| endTime   | String | No       | End time            |
| region    | String | No       | Billing region      |
| protocol  | String | No       | Protocol type       |
| domain    | String | No       | Acceleration domain |
| group     | String | No       | Group type          |

## StatusCodeDetailData

CDN status code details

| Name  | Type    | Required | Description |
| ----- | ------- | -------- | ----------- |
| code  | String  | Yes      | Status code |
| count | Integer | Yes      | Count       |

## StatusCodeData

CDN status code data

| Name   | Type                                                   | Required | Description         |
| ------ | ------------------------------------------------------ | -------- | ------------------- |
| domain | String                                                 | No       | Acceleration domain |
| detail | Array of [StatusCodeDetailData](#statuscodedetaildata) | Yes      | Status code details |

## RankingBandwidthData

Bandwidth ranking data

| Name         | Type    | Required | Description              |
| ------------ | ------- | -------- | ------------------------ |
| domain       | String  | Yes      | Acceleration domain      |
| maxbandwidth | Double  | Yes      | Peak bandwidth,Unit Mbps |
| requests     | Integer | Yes      | Peak request count       |
| traffic      | Double  | Yes      | Peak traffic,Unit MB     |
| time         | String  | Yes      | Peak time                |

## RankingIpData

IP ranking data

| Name    | Type    | Required | Description           |
| ------- | ------- | -------- | --------------------- |
| ip      | String  | Yes      | Access IP             |
| isp     | String  | Yes      | ISP                   |
| count   | Integer | Yes      | Total count           |
| traffic | Double  | Yes      | Total traffic,Unit MB |

## RankingUrlData

URL ranking data

| Name    | Type    | Required | Description           |
| ------- | ------- | -------- | --------------------- |
| url     | String  | Yes      | Request URL           |
| count   | Integer | Yes      | Total count           |
| traffic | Double  | Yes      | Total traffic,Unit MB |

## RankingRefererData

Referer ranking data

| Name    | Type    | Required | Description           |
| ------- | ------- | -------- | --------------------- |
| referer | String  | Yes      | Referer               |
| count   | Integer | Yes      | Total count           |
| traffic | Double  | Yes      | Total traffic,Unit MB |

## RankingUvData

UV ranking data

| Name    | Type    | Required | Description           |
| ------- | ------- | -------- | --------------------- |
| domain  | String  | Yes      | Acceleration domain   |
| count   | Integer | Yes      | Total count           |
| traffic | Double  | Yes      | Total traffic,Unit MB |

## VisitData

Page view/unique visitor data

| Name    | Type    | Required | Description     |
| ------- | ------- | -------- | --------------- |
| time    | String  | Yes      | Time            |
| count   | Integer | Yes      | Count           |
| traffic | Double  | Yes      | Traffic,Unit MB |

## CertificateInfo

Certificate information

| Name             | Type            | Required | Description                                                                                                                                                           |
| ---------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| certificateId    | String          | No       | <p>Certificate ID</p><p>Due to compatibility with older certificate upload formats, this field may be empty in <code>DescribeAccelerators</code></p>                  |
| certificateLabel | String          | Yes      | Custom certificate label                                                                                                                                              |
| common           | String          | Yes      | Certificate common name                                                                                                                                               |
| fingerprint      | String          | Yes      | MD5 certificate fingerprint                                                                                                                                           |
| issuer           | String          | Yes      | Certificate issuer                                                                                                                                                    |
| sans             | Array of String | Yes      | Subject Alternative Names                                                                                                                                             |
| algorithm        | String          | Yes      | Encryption algorithm                                                                                                                                                  |
| createTime       | Timestamp       | Yes      | <p>Certificate creation time</p><p>Formatted according to <code>ISO8601</code> standard, using <code>UTC</code> time. Format: <code>YYYY-MM-DDThh:mm:ssZ</code></p>   |
| startTime        | Timestamp       | Yes      | <p>Certificate start time</p><p>Formatted according to <code>ISO8601</code> standard, using <code>UTC</code> time. Format: <code>YYYY-MM-DDThh:mm:ssZ</code></p>      |
| endTime          | Timestamp       | Yes      | <p>Certificate expiration time</p><p>Formatted according to <code>ISO8601</code> standard, using <code>UTC</code> time. Format: <code>YYYY-MM-DDThh:mm:ssZ</code></p> |
| expired          | Boolean         | Yes      | Whether the certificate is expired                                                                                                                                    |
| resourceGroupId  | String          | No       | <p>Resource group ID of the instance</p><p><code>DescribeAccelerators</code> does not return this field</p>                                                           |