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

# 数据结构

## AccelerateAlertType

警报类型

| 类型值                      | 类型说明         |
| ------------------------ | ------------ |
| OrginNotAvaliable        | 源站不可用        |
| VipDetectionNotAvaliable | 加速区域虚拟 IP 不通 |

## AcceleratorAlert

加速器警报信息

| 名称            | 类型                                                                      | 必选 | 描述                                                                                                                             |
| ------------- | ----------------------------------------------------------------------- | -- | ------------------------------------------------------------------------------------------------------------------------------ |
| acceleratorId | String                                                                  | 是  | 加速器 Id                                                                                                                         |
| alertId       | String                                                                  | 是  | 警报 Id                                                                                                                          |
| alertType     | String                                                                  | 是  | 警报类型                                                                                                                           |
| labels        | Map                                                                     | 否  | 警报标签                                                                                                                           |
| message       | String                                                                  | 是  | 警报信息                                                                                                                           |
| startTime     | [Timestamp](/api-reference/cn/api-introduction/instruction/datatype.md) | 是  | <p>警报开始时间</p><p>按照<code>ISO8601</code>标准表示，并且使用<code>UTC</code>时间。格式为：<code>YYYY-MM-DDThh:mm:ssZ。</code></p>                   |
| endTime       | [Timestamp](/api-reference/cn/api-introduction/instruction/datatype.md) | 否  | <p>警报恢复时间</p><p>Null: 未恢复警报</p><p>按照<code>ISO8601</code>标准表示，并且使用<code>UTC</code>时间。格式为：<code>YYYY-MM-DDThh:mm:ssZ。</code></p> |

## AcceleratorLog

加速器日志信息

| 名称      | 类型      | 必选 | 描述         |
| ------- | ------- | -- | ---------- |
| logUrl  | String  | 是  | 下载地址       |
| logName | String  | 是  | 日志名称       |
| logSize | Integer | 是  | 日志大小，单位: B |

## AcceleratorMetricsData

加速器指标数据

| 名称                      | 类型      | 必选 | 描述                                                                        |
| ----------------------- | ------- | -- | ------------------------------------------------------------------------- |
| requestCount            | Integer | 是  | 请求数                                                                       |
| averageDownloadSpeed    | Double  | 是  | 下载平均速率。单位：bps                                                             |
| averageFirstByteTime    | Double  | 是  | 首包接收平均耗时。单位：ms                                                            |
| averageSslHandshakeTime | Double  | 是  | SSL 握手平均耗时，只支持七层协议（http/https）。单位：ms                                      |
| averageRequestTime      | Double  | 是  | 请求平均耗时。单位：ms                                                              |
| time                    | String  | 是  | <p>数据时间</p><p>格式为: <code>YYYY-MM-DDThh:mm:ssZ</code></p><p>时间颗粒度: 60s</p> |

## AcceleratorTrafficData

加速器带宽数据

| 名称         | 类型      | 必选 | 描述                                                                         |
| ---------- | ------- | -- | -------------------------------------------------------------------------- |
| internetRX | Integer | 是  | 入口带宽。单位：bps                                                                |
| internetTX | Integer | 是  | 出口带宽。单位：bps                                                                |
| time       | String  | 是  | <p>数据时间</p><p>格式为: <code>YYYY-MM-DDThh:mm:ssZ</code></p><p>时间颗粒度: 300s</p> |

## AccelerateRegion

加速器加速区域信息

| 名称                 | 类型      | 必选 | 描述                    |
| ------------------ | ------- | -- | --------------------- |
| accelerateRegionId | String  | 是  | [区域 Id](#region)      |
| bandwidth          | Integer | 否  | 默认值: 套餐包最大带宽，单位: Mbps |
| vip                | String  | 否  | 加速区域接入点虚拟 IP          |

## AccelerateRegionInfo

加速器加速区域信息

| 名称                     | 类型      | 必选 | 描述                                                   |
| ---------------------- | ------- | -- | ---------------------------------------------------- |
| accelerateRegionId     | String  | 是  | [区域 Id](#region)                                     |
| accelerateRegionName   | String  | 是  | 区域名称                                                 |
| accelerateRegionStatus | String  | 是  | 加速区域状态, 取值范围见[加速区域状态表](#accelerateregionstatusvalue) |
| vip                    | String  | 是  | 加速区域接入点虚 IP                                          |
| bandwidth              | Integer | 是  | 接入点带宽限速，单位: Mbps                                     |

## AccelerateRegionStatusValue

加速区域状态

| 状态值          | 状态说明  |
| ------------ | ----- |
| InProcessing | 下发配置中 |
| Success      | 配置成功  |
| Abnormal     | 加速暂停  |

## AccelerationRuleL4Listener

加速器加速规则 L4 配置

| 名称            | 类型      | 必选     | 描述                                                                                                                                                                  |
| ------------- | ------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| port          | Integer | 否      | <p>加速端口</p><p>port 和 portRange 有且仅有一个, 端口不允许重复</p><p>取值范围：<strong>1</strong>\~<strong>65535</strong></p>                                                            |
| backPort      | Integer | 否      | <p>回源端口</p><p>默认等于 port</p><p>取值范围：<strong>1</strong>\~<strong>65535</strong></p>                                                                                   |
| portRange     | 否       | String | 加速端口范围, port 和 portRange 有且仅有一个, 端口不允许重复。取值范围：**1**\~**65535**。使用斜线（/）隔开起始端口和终止端口。正确示范：**1/200**；错误示范：**200/1**                                                     |
| backPortRange | String  | 否      | <p>回源端口范围</p><p>默认等于 portRange</p><p>取值范围：<strong>1</strong>\~<strong>65535</strong>。使用斜线（/）隔开起始端口和终止端口。正确示范：<strong>1/200</strong>；错误示范：<strong>200/1</strong></p> |
| protocol      | String  | 是      | <p>加速协议</p><ul><li>tcp：TCP 协议。</li><li>udp：UDP 协议。</li></ul>                                                                                                        |

## AccelerationRuleL7Listener

加速器加速规则 L7 配置

| 名称            | 类型      | 必选     | 描述                                                                                                                                                                  |
| ------------- | ------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| port          | Integer | 否      | <p>加速端口</p><p>port 和 portRange 有且仅有一个, 端口不允许重复</p><p>取值范围：<strong>1</strong>\~<strong>65535</strong></p>                                                            |
| backPort      | Integer | 否      | <p>回源端口</p><p>默认等于 port</p><p>取值范围：<strong>1</strong>\~<strong>65535</strong></p>                                                                                   |
| portRange     | 否       | String | 加速端口范围, port 和 portRange 有且仅有一个, 端口不允许重复。取值范围：**1**\~**65535**。使用斜线（/）隔开起始端口和终止端口。正确示范：**1/200**；错误示范：**200/1**                                                     |
| backPortRange | String  | 否      | <p>回源端口范围</p><p>默认等于 portRange</p><p>取值范围：<strong>1</strong>\~<strong>65535</strong>。使用斜线（/）隔开起始端口和终止端口。正确示范：<strong>1/200</strong>；错误示范：<strong>200/1</strong></p> |
| protocol      | String  | 是      | <p>加速协议</p><ul><li>http：HTTP 协议。</li><li>https：HTTPS 协议。</li></ul>                                                                                                  |
| backProtocol  | String  | 否      | <p>回源加速协议, 默认等于 protocol</p><ul><li>http：HTTP 协议。</li><li>https：HTTPS 协议。</li></ul>                                                                                 |
| host          | String  | 否      | 回源自定义 host                                                                                                                                                          |

## AccelerationRuleProtocolOpts

加速器加速规则协议可选配置

| 名称            | 类型      | 必选 | 描述                                                                                |
| ------------- | ------- | -- | --------------------------------------------------------------------------------- |
| toa           | Boolean | 否  | <p>是否开启 toa，只能存在 L4 加速生效</p><p>默认值: false</p>                                     |
| toaValue      | Integer | 否  | toa 版本号，默认值：253                                                                   |
| websocket     | Boolean | 否  | <p>是否开启 websocket，只能存在 L7 加速生效</p><p>默认值: false</p>                               |
| proxyProtocol | Boolean | 否  | <p>是否开启 proxyProtocol，只能存在 L4 加速生效</p><p>默认值: false</p>                           |
| gzip          | Boolean | 否  | <p>是否开启 gzip 压缩，只能存在 L7 加速生效</p><p>默认值: false</p>                                 |
| sniCheck      | Boolean | 否  | <p>是否开启 sniCheck，TCP 协议代理支持 SNI 校验，只能在域名加速器中生效</p><p>默认值: false</p>               |
| httpRedirect  | Boolean | 否  | <p>是否开启 http:80 重定向到 https:443，必须配置 http:80 和 https:443 加速规则</p><p>默认值: false</p> |

## AcceleratorInfo

加速器信息

| 名称                | 类型                                                                      | 必选 | 描述                                                                                                            |
| ----------------- | ----------------------------------------------------------------------- | -- | ------------------------------------------------------------------------------------------------------------- |
| acceleratorId     | String                                                                  | 是  | 加速器 Id                                                                                                        |
| acceleratorType   | String                                                                  | 是  | 加速器类型，取值范围见[加速器类型表](#acceleratortypevalue)                                                                    |
| acceleratorName   | String                                                                  | 是  | 加速器名称                                                                                                         |
| chargeType        | String                                                                  | 是  | 计费类型，取值范围见[计费类型表](#acceleratorchargetype)                                                                     |
| domain            | [Domain](#domain)                                                       | 否  | <p>加速域名</p><p>若加速器为 IP 加速，则 domain 返回为空字符串</p>                                                                |
| acceleratorStatus | String                                                                  | 是  | 加速器状态，取值范围见[加速器状态表](#acceleratorstatusvalue)                                                                  |
| cname             | String                                                                  | 是  | 加速器 CNAME                                                                                                     |
| origin            | [OriginInfo](#origininfo)                                               | 是  | 加速器源站信息                                                                                                       |
| accelerateRegions | Array of [AccelerateRegionInfo](#accelerateregioninfo)                  | 是  | 加速区域信息                                                                                                        |
| l4Listeners       | Array of [AccelerationRuleL4Listener](#accelerationrulel4listener)      | 是  | 加速器加速规则 L4 配置                                                                                                 |
| l7Listeners       | Array of [AccelerationRuleL7Listener](#accelerationrulel7listener)      | 是  | 加速器加速规则 L7 配置                                                                                                 |
| protocolOpts      | [AccelerationRuleProtocolOpts](#accelerationruleprotocolopts)           | 是  | 加速器加速规则协议可选配置                                                                                                 |
| certificate       | [CertificateInfo](#certificateinfo)                                     | 是  | 加速器证书配置                                                                                                       |
| accessControl     | [AccessControl](#accesscontrol)                                         | 是  | 加速器访问控制                                                                                                       |
| healthCheck       | [HealthCheck](#healthcheck)                                             | 是  | 健康检查配置                                                                                                        |
| createTime        | [Timestamp](/api-reference/cn/api-introduction/instruction/datatype.md) | 是  | <p>加速器创建时间</p><p>按照<code>ISO8601</code>标准表示，并且使用<code>UTC</code>时间。格式为：<code>YYYY-MM-DDThh:mm:ssZ。</code></p> |
| resourceGroupId   | String                                                                  | 是  | 加速器所属资源组的 ID                                                                                                  |

## AcceleratorChargeType

加速器计费类型

| 类型               | 类型说明     |
| ---------------- | -------- |
| ByTrafficPackage | 购买流量包计费  |
| ByBandwidth95    | 合并 95 计费 |
| ByBandwidth      | 按固定带宽计费  |
| ByTraffic        | 按流量计费    |
| ByPoc            | POC 测试   |

## AcceleratorStatusValue

加速器的状态。

| 状态值               | 状态说明 |
| ----------------- | ---- |
| Accelerating      | 加速中  |
| NotAccelerate     | 未加速  |
| Deploying         | 部署中  |
| StopAccelerate    | 停止   |
| AccelerateFailure | 失败   |

## AcceleratorTypeValue

加速器类型

| 类型            | 类型说明                                   |
| ------------- | -------------------------------------- |
| CustomRouting | <p>自定义路由加速</p><p>通过独立 IP 精准加速单个区域</p>  |
| Standard      | <p>标准加速</p><p>通过 Anycast IP 加速全球区域</p> |

## AccessControl

加速器访问控制

| 名称     | 类型                                               | 必选 | 描述       |
| ------ | ------------------------------------------------ | -- | -------- |
| enable | Boolean                                          | 是  | 是否开启访问控制 |
| rules  | Array of [AccessControlRule](#accesscontrolrule) | 是  | 访问控制规则   |

## AccessControlRule

加速器访问控制规则

| 名称        | 类型     | 必选 | 描述                                                                                                                                       |
| --------- | ------ | -- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| listener  | String | 是  | <p>访问控制生效的加速规则</p><ul><li>单端口: $protocol:$port, 例如: http:80</li><li>端口段: $protocol:$portRange, 例如: tcp:80/100</li><li>全端口: all</li></ul> |
| directory | String | 否  | <p>访问控制目录</p><p>4 层端口加速不可配置，支持通配符: \*</p>                                                                                                |
| cidrIp    | String | 是  | <p>访问控制 IP 地址范围，支持 CIDR 格式和 IPv4 格式</p><p>支持批量,逗号分隔</p>                                                                                  |
| policy    | String | 是  | <p>加速器访问控制策略</p><ul><li>accept-接受访问</li><li>deny-拒绝访问</li></ul>                                                                          |
| note      | String | 否  | 备注                                                                                                                                       |

## 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](/api-reference/cn/api-introduction/instruction/datatype.md) | 是  | <p>证书创建时间</p><p>按照<code>ISO8601</code>标准表示，并且使用<code>UTC</code>时间。格式为：<code>YYYY-MM-DDThh:mm:ssZ。</code></p> |
| startTime        | [Timestamp](/api-reference/cn/api-introduction/instruction/datatype.md) | 是  | <p>证书开始时间</p><p>按照<code>ISO8601</code>标准表示，并且使用<code>UTC</code>时间。格式为：<code>YYYY-MM-DDThh:mm:ssZ。</code></p> |
| endTime          | [Timestamp](/api-reference/cn/api-introduction/instruction/datatype.md) | 是  | <p>证书过期时间</p><p>按照<code>ISO8601</code>标准表示，并且使用<code>UTC</code>时间。格式为：<code>YYYY-MM-DDThh:mm:ssZ。</code></p> |
| expired          | Boolean                                                                 | 是  | 证书是否过期                                                                                                       |
| resourceGroupId  | String                                                                  | 否  | <p>实例所属资源组的 ID</p><p><code>DescribeAccelerators</code>不返回此字段</p>                                             |

## Domain

加速器加速区域信息

| 名称            | 类型     | 必选 | 描述                                           |
| ------------- | ------ | -- | -------------------------------------------- |
| domain        | String | 是  | <p>加速主域名</p><p>支持泛域名，例如：\*.xx.com</p>        |
| relateDomains | String | 否  | <p>关联域名</p><p>可支持批量域名, 最多 10 个, 逗号或者分号分隔</p> |

## HealthCheck

健康检查配置

| 名称     | 类型      | 必选 | 描述                                                    |
| ------ | ------- | -- | ----------------------------------------------------- |
| enable | Boolean | 是  | <p>是否开启健康检查</p><p>若关闭健康检查，则告警会被设置成 false，探测端口被清空</p>  |
| alarm  | Boolean | 否  | <p>是否开启异常告警</p><p>默认值: false</p>                      |
| port   | Integer | 否  | <p>探测端口</p><p>若未配置探测端口，则默认探测排除 UDP 和 TCP 端口段的所有端口</p> |

## Origin

加速器源站信息

| 名称             | 类型     | 必选 | 描述                                                                                                                                         |
| -------------- | ------ | -- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| originRegionId | String | 否  | <p><a href="#region">区域 Id</a></p><ul><li><code>CreateAccelerator</code>为必传参数</li><li><code>ModifyAcceleratorOrigin</code>不支持此参数</li></ul> |
| origin         | String | 是  | <p>加速源站</p><ul><li>CNAME: 仅支持配置一个</li><li>IP: 可批量配置, 逗号或者分号分隔</li></ul>                                                                    |
| backupOrigin   | String | 否  | <p>备源站</p><p>origin 配置 IP，backupOrigin 才可以生效</p><ul><li>CNAME: 仅支持配置一个</li><li>IP: 可批量配置, 逗号或者分号分隔</li></ul>                               |

## OriginInfo

加速器源站信息

| 名称               | 类型     | 必选 | 描述                                                                                                           |
| ---------------- | ------ | -- | ------------------------------------------------------------------------------------------------------------ |
| originRegionId   | String | 是  | [区域 Id](#region)                                                                                             |
| originRegionName | String | 是  | 区域名称                                                                                                         |
| origin           | String | 是  | <p>加速源站</p><ul><li>CNAME: 仅支持配置一个</li><li>IP: 可批量配置, 逗号或者分号分隔</li></ul>                                      |
| backupOrigin     | String | 否  | <p>备源站</p><p>origin 配置 IP，backupOrigin 才可以生效</p><ul><li>CNAME: 仅支持配置一个</li><li>IP: 可批量配置, 逗号或者分号分隔</li></ul> |

## Region

可用区信息

| 名称         | 类型     | 必选 | 描述                       |
| ---------- | ------ | -- | ------------------------ |
| regionId   | String | 是  | <p>可用区 ID。<br>例如：SEL</p> |
| regionName | String | 是  | 可用区的名称。                  |

## ResourceGroupBandwidthLimitInfo

可用区信息

| 名称              | 类型      | 必选 | 描述                                                                                   |
| --------------- | ------- | -- | ------------------------------------------------------------------------------------ |
| resourceGroupId | String  | 是  | 资源组 ID。                                                                              |
| enable          | Boolean | 是  | <p>是否开启资源组限速。</p><p>若不开启资源组限速，则以<a href="#accelerateregioninfo">加速区域</a>设置的限速为准。</p> |
| bandwidth       | Integer | 是  | <p>共享带宽限速，</p><p>单位: Mbps，最小值 1。</p><p>最大值为账号设置的最大限速。</p>                            |

## StatusCodeDetailData

cdn状态码明细

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

## StatusCodeData

cdn状态码数据

| 名称     | 类型                                                     | 必选 | 描述                                                       |
| ------ | ------------------------------------------------------ | -- | -------------------------------------------------------- |
| time   | String                                                 | 是  | <p>数据时间</p><p>格式为: <code>YYYY-MM-DDThh:mm:ssZ</code></p> |
| detail | Array of [StatusCodeDetailData](#statuscodedetaildata) | 是  | 状态码明细                                                    |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.console.zenlayer.com/api-reference/cn/networking/zga/datastructure.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.