For the complete documentation index, see llms.txt. This page is also available as Markdown.

Data Types

AccelerateAlertType

Alert Type

Type
Description

OrginNotAvaliable

Origin Not Available

VipDetectionNotAvaliable

Acceleration Region VIP Not Reachable

AcceleratorAlert

Accelerator Alert Information

Parameter Name
Type
Required
Description

acceleratorId

String

Yes

Accelerator Id

alertId

String

Yes

Alert Id

alertType

String

Yes

Alert Type

labels

Map

No

Alert Labels

message

String

Yes

Alert Message

startTime

Yes

Alert Start Time

Uses the ISO8601 standard and UTC time. Format: YYYY-MM-ddTHH:mm:ssZ.

endTime

No

Alert Recovery Time

Null: Alert Not Recovered

Uses the ISO8601 standard and UTC time. Format: YYYY-MM-ddTHH:mm:ssZ.

AcceleratorLog

Accelerator Log Information

Parameter Name
Type
Required
Description

logUrl

String

Yes

Download URL

logName

String

Yes

Log Name

logSize

Integer

Yes

Log Size, Unit: B

AcceleratorMetricsData

Accelerator Metrics Data

Parameter Name
Type
Required
Description

requestCount

Integer

Yes

Request Count

averageDownloadSpeed

Double

Yes

Average Download Speed. Unit: bps

averageFirstByteTime

Double

Yes

Average Time to First Byte. Unit: ms

averageSslHandshakeTime

Double

Yes

Average SSL Handshake Time, only supported for Layer 7 protocols (http/https). Unit: ms

averageRequestTime

Double

Yes

Average Request Time. Unit: ms

time

String

Yes

Data Time

Format: YYYY-MM-ddTHH:mm:ssZ

Time Granularity: 60s

AcceleratorTrafficData

Accelerator Bandwidth Data

Parameter Name
Type
Required
Description

internetRX

Integer

Yes

Inbound Bandwidth. Unit: bps

internetTX

Integer

Yes

Outbound Bandwidth. Unit: bps

time

String

Yes

Data Time

Format: YYYY-MM-ddTHH:mm:ssZ

Time Granularity: 300s

AccelerateRegion

Accelerator Acceleration Region Information

Parameter Name
Type
Required
Description

accelerateRegionId

String

Yes

bandwidth

Integer

No

Default Value: Maximum Bandwidth in Package Plan, Unit: Mbps

vip

String

No

Acceleration Region Access Point VIP

AccelerateRegionInfo

Accelerator Acceleration Region Information

Parameter Name
Type
Required
Description

accelerateRegionId

String

Yes

accelerateRegionName

String

Yes

Region Name

accelerateRegionStatus

String

Yes

Acceleration Region Status, see Acceleration Region Status Table

vip

String

Yes

Acceleration Region Access Point VIP

bandwidth

Integer

Yes

Access Point Bandwidth Limit, Unit: Mbps

AccelerateRegionStatusValue

Acceleration Region Status

State
Description

InProcessing

Configuration in Progress

Success

Configuration Successful

Abnormal

Acceleration Paused

AccelerationRuleL4Listener

Accelerator Acceleration Rule L4 Configuration

Parameter Name
Type
Required
Description

port

Integer

No

Acceleration Port

Either port or portRange is required, but not both. Ports cannot be repeated

Value Range: 1~65535

backPort

Integer

No

Origin Port

Default equals port

Value Range: 1~65535

portRange

String

No

Acceleration Port Range. Either port or portRange is required, but not both. Ports cannot be repeated. Value Range: 1~65535. Use slash (/) to separate start and end ports. Correct Example: 1/200; Incorrect Example: 200/1

backPortRange

String

No

Origin Port Range

Default equals portRange

Value Range: 1~65535. Use slash (/) to separate start and end ports. Correct Example: 1/200; Incorrect Example: 200/1

protocol

String

Yes

Acceleration Protocol

  • tcp: TCP Protocol.

  • udp: UDP Protocol.

AccelerationRuleL7Listener

Accelerator Acceleration Rule L7 Configuration

Parameter Name
Type
Required
Description

port

Integer

No

Acceleration Port

Either port or portRange is required, but not both. Ports cannot be repeated

Value Range: 1~65535

backPort

Integer

No

Origin Port

Default equals port

Value Range: 1~65535

portRange

String

No

Acceleration Port Range. Either port or portRange is required, but not both. Ports cannot be repeated. Value Range: 1~65535. Use slash (/) to separate start and end ports. Correct Example: 1/200; Incorrect Example: 200/1

backPortRange

String

No

Origin Port Range

Default equals portRange

Value Range: 1~65535. Use slash (/) to separate start and end ports. Correct Example: 1/200; Incorrect Example: 200/1

protocol

String

Yes

Acceleration Protocol

  • http: HTTP Protocol.

  • https: HTTPS Protocol.

backProtocol

String

No

Origin Acceleration Protocol, default equals protocol

  • http: HTTP Protocol.

  • https: HTTPS Protocol.

host

String

No

Origin Custom Host

AccelerationRuleProtocolOpts

Accelerator Acceleration Rule Protocol Options

Parameter Name
Type
Required
Description

toa

Boolean

No

Whether to Enable TOA, only applies to L4 acceleration

Default Value: false

toaValue

Integer

No

TOA Version Number, Default Value: 253

websocket

Boolean

No

Whether to Enable WebSocket, only applies to L7 acceleration

Default Value: false

proxyProtocol

Boolean

No

Whether to Enable ProxyProtocol, only applies to L4 acceleration

Default Value: false

gzip

Boolean

No

Whether to Enable Gzip Compression, only applies to L7 acceleration

Default Value: false

sniCheck

Boolean

No

Whether to Enable SNI Check, TCP Protocol Proxy Supports SNI Verification, only applies to domain accelerators

Default Value: false

httpRedirect

Boolean

No

Whether to Enable HTTP:80 Redirect to HTTPS:443, must configure both HTTP:80 and HTTPS:443 acceleration rules

Default Value: false

AcceleratorInfo

Accelerator Information

Parameter Name
Type
Required
Description

acceleratorId

String

Yes

Accelerator Id

acceleratorType

String

Yes

Accelerator Type, see Accelerator Type Table

acceleratorName

String

Yes

Accelerator Name

chargeType

String

Yes

Billing Type, see Billing Type Table

domain

No

Acceleration Domain

If the accelerator is IP acceleration, domain returns empty string

acceleratorStatus

String

Yes

Accelerator Status, see Accelerator Status Table

cname

String

Yes

Accelerator CNAME

origin

Yes

Accelerator Origin Information

accelerateRegions

Yes

Acceleration Region Information

l4Listeners

Yes

Accelerator Acceleration Rule L4 Configuration

l7Listeners

Yes

Accelerator Acceleration Rule L7 Configuration

protocolOpts

Yes

Accelerator Acceleration Rule Protocol Options

certificate

Yes

Accelerator Certificate Configuration

accessControl

Yes

Accelerator Access Control

healthCheck

Yes

Health Check Configuration

createTime

Yes

Accelerator Creation Time

Uses the ISO8601 standard and UTC time. Format: YYYY-MM-ddTHH:mm:ssZ.

resourceGroupId

String

Yes

Resource Group ID to which the accelerator belongs

AcceleratorChargeType

Accelerator Billing Type

Type
Description

ByTrafficPackage

Traffic Package Billing

ByBandwidth95

Merged 95th Percentile Billing

ByBandwidth

Fixed Bandwidth Billing

ByTraffic

Traffic Billing

ByPoc

POC Testing

AcceleratorStatusValue

Accelerator Status

State
Description

Accelerating

Accelerating

NotAccelerate

Not Accelerating

Deploying

Deploying

StopAccelerate

Stopped

AccelerateFailure

Failed

AcceleratorTypeValue

Accelerator Type

Type
Description

CustomRouting

Custom Routing Acceleration

Precise acceleration of a single region through independent IP

Standard

Standard Acceleration

Global region acceleration through Anycast IP

AccessControl

Accelerator Access Control

Parameter Name
Type
Required
Description

enable

Boolean

Yes

Whether to Enable Access Control

rules

Yes

Access Control Rules

AccessControlRule

Accelerator Access Control Rule

Parameter Name
Type
Required
Description

listener

String

Yes

Acceleration Rule to which Access Control Applies

  • Single Port: $protocol:$port, Example: http:80

  • Port Range: $protocol:$portRange, Example: tcp:80/100

  • All Ports: all

directory

String

No

Access Control Directory

Cannot be configured for Layer 4 port acceleration, supports wildcard: *

cidrIp

String

Yes

Access Control IP Address Range, supports CIDR format and IPv4 format

Supports batch configuration, comma-separated

policy

String

Yes

Accelerator Access Control Policy

  • accept-Allow Access

  • deny-Deny Access

note

String

No

Remark

CertificateInfo

Certificate Information

Parameter Name
Type
Required
Description

certificateId

String

No

Certificate Id

For compatibility with the old certificate upload format, this field may be empty in DescribeAccelerators return

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

Yes

Certificate Creation Time

Uses the ISO8601 standard and UTC time. Format: YYYY-MM-ddTHH:mm:ssZ.

startTime

Yes

Certificate Start Time

Uses the ISO8601 standard and UTC time. Format: YYYY-MM-ddTHH:mm:ssZ.

endTime

Yes

Certificate Expiration Time

Uses the ISO8601 standard and UTC time. Format: YYYY-MM-ddTHH:mm:ssZ.

expired

Boolean

Yes

Whether the Certificate is Expired

resourceGroupId

String

No

Resource Group ID to which the instance belongs

DescribeAccelerators does not return this field

Domain

Accelerator Acceleration Domain Information

Parameter Name
Type
Required
Description

domain

String

Yes

Acceleration Primary Domain

Supports wildcard domain, example: *.xx.com

relateDomains

String

No

Related Domains

Supports batch domain configuration, maximum 10, comma or semicolon-separated

HealthCheck

Health Check Configuration

Parameter Name
Type
Required
Description

enable

Boolean

Yes

Whether to Enable Health Check

If health check is disabled, Alerts will be set to false and probe port will be cleared

alarm

Boolean

No

Whether to Enable Exception Alert

Default Value: false

port

Integer

No

Probe Port

If probe port is not configured, all ports except UDP and TCP port ranges will be probed by default

Origin

Accelerator Origin Information

Parameter Name
Type
Required
Description

originRegionId

String

No

Region Id

  • CreateAccelerator requires this parameter

  • ModifyAcceleratorOrigin does not support this parameter

origin

String

Yes

Acceleration Origin

  • CNAME: Only one can be configured

  • IP: Can be configured in batch, comma or semicolon-separated

backupOrigin

String

No

Backup Origin

backupOrigin can only take effect when origin is configured with IP

  • CNAME: Only one can be configured

  • IP: Can be configured in batch, comma or semicolon-separated

OriginInfo

Accelerator Origin Information

Parameter Name
Type
Required
Description

originRegionId

String

Yes

originRegionName

String

Yes

Region Name

origin

String

Yes

Acceleration Origin

  • CNAME: Only one can be configured

  • IP: Can be configured in batch, comma or semicolon-separated

backupOrigin

String

No

Backup Origin

backupOrigin can only take effect when origin is configured with IP

  • CNAME: Only one can be configured

  • IP: Can be configured in batch, comma or semicolon-separated

Region

Available Zone Information

Parameter Name
Type
Required
Description

regionId

String

Yes

Available Zone ID. Example: SEL

regionName

String

Yes

Available Zone Name

ResourceGroupBandwidthLimitInfo

Available Zone Information

Parameter Name
Type
Required
Description

resourceGroupId

String

Yes

Resource Group ID.

enable

Boolean

Yes

Whether to Enable Resource Group Bandwidth Limit.

If resource group bandwidth limit is not enabled, the bandwidth limit set in Acceleration Region will apply.

bandwidth

Integer

Yes

Shared Bandwidth Limit,

Unit: Mbps, Minimum Value: 1.

Maximum Value is the maximum bandwidth limit set for the account.

StatusCodeDetailData

CDN Status Code Details

Parameter Name
Type
Required
Description

code

String

Yes

Status Code

count

Integer

Yes

Count

StatusCodeData

Status Code Data

Parameter Name
Type
Required
Description

time

String

Yes

Data Time

Format: YYYY-MM-ddTHH:mm:ssZ

detail

Yes

Status Code Details

Last updated