Appendix 1

EIP

  • API Reference
    • API function release records
    • API Service Domain Name
    • API Specifications
    • Appendix 1
    • Bandwidth Package Related Interfaces
      • Adjust the bandwidth of the bandwidth package
      • Create bandwidth package
      • Query bandwidth package details
      • Query bandwidth package list information of users
      • Release bandwidth package
      • Update the automatic release time of the bandwidth package
      • Update the name of the bandwidth package
    • DDoS Basic Protection Related Interfaces
      • Modify DDoS basic protection threshold
      • Query DDoS Basic Protection Attack Records
      • Query DDoS basic protection list
    • EIP Related Interfaces
      • Apply for EIP
      • Bind EIP
      • Disable EIP direct
      • EIP bandwidth scaling
      • EIP renewal has been enabled
      • Enable EIP direct
      • Query EIP list in bucket trash
      • Query EIP list
      • Release EIP
      • Release EIPs in the bucket trash
      • Renew EIP
      • Restore EIPs in the bucket trash
      • Selective release of EIP
      • Unbind EIP
      • Unsubscribe prepaid EIP
      • Update EIP Release Protection Switch
    • Error code
    • General Description
    • Inquiry Related
      • Bandwidth package price inquiry
      • EIP Inquiry
      • EIPGROUP Inquiry
      • Shared Traffic Package Inquiry
    • Interface Overview
    • Overview
    • Prerequisites for use
    • Shared Bandwidth Related Interfaces
      • Bandwidth scaling up for EIPGROUP
      • Create EIPGROUP
      • EIPGROUP IP count upgrade
      • EIPGROUP release
      • EIPGROUP renewal
      • EIPGROUP update
      • Migrate EIP from EIPGROUP
      • Migrate EIP into EIPGROUP
      • Query EIPGROUP details
      • Query the EIPGROUP list
      • Unsubscribe prepaid EIPGROUP
    • Shared Traffic Package Related Interfaces
      • Create a shared traffic package
      • Query shared traffic package details
      • Query shared traffic package list
    • TBSP Related Interfaces
      • Add Protection IP Allow List
      • Add Protocol Blocking
      • Add Region Blocking
      • Bind Protection Object
      • Close Protection IP Cleaning
      • Create TBSP
      • Delete Protection IP Allow List
      • Delete Protection Object
      • Delete Protocol Blocking
      • Delete Region Blocking
      • Modify Protection IP Cleaning Threshold
      • Modify Protection IP Protection Level
      • Open Protection IP Cleaning
      • Query Protection IP Allow List
      • Query Protection IP Cleaning Threshold List
      • Query Protocol Blocking List
      • Query Region Blocking List
      • Query TBSP Details
      • Query TBSP List
      • TBSP Capacity dilatation
      • TBSP renew
  • FAQs
    • Billing class
    • Configuration
    • Consultation
    • Security class
  • Function Release Records
  • Operation guide
    • Address pool
    • Bandwidth package
      • Bandwidth scale-up package
      • Cross-border acceleration package
    • Certification
    • DDoS standard protection
    • EIP Instance
      • Create instance
      • EIP Direct Connect
      • IPv6 Termination
      • Manage Alarms
      • Operation Instance
      • Shift Charge
      • View monitoring
    • EIP Self-Service Diagnostics
      • EIP Instance Diagnosis
    • EIPGROUP
      • Bind cloud resources
      • Manage Shared Bandwidth
      • Purchase Shared Bandwidth
      • View monitoring
    • High Defense EIP
    • Identity and access management
    • Recycle bin
    • Shared traffic package
      • Purchase Shared Traffic Package
      • View Shared Traffic Package
    • Tag Management
    • Traffic Burst Service Package
      • Instance management
      • Monitor alarm
      • Protection Configuration
    • Unblocking Center
  • Product Description
    • Application scenarios
    • Product advantages
    • Product Introduction
    • Usage restrictions
  • Product pricing
    • Bandwidth Package Billing
    • EIP Instance Billing
    • EIPGROUP Billing
    • Shared Traffic Package Billing
    • TBSP Billing
  • SDK
    • GO-SDK
      • DDoS Instance
      • EIP Instance
      • EipBp Instance
      • EIPGROUP Instance
      • EipTp Instance
      • Exception handling
      • Initialization
      • Install the SDK Package
      • Overview
    • Java-SDK
      • EIP Instance
      • EipBP Instance
      • EIPGROUP Instance
      • EipTp Instance
      • Exception handling
      • Initialization
      • Install the SDK Package
      • Overview
      • Version history
    • PHP-SDK
      • EIP Instance
      • EipBP Instance
      • EIPGROUP Instance
      • Exception handling
      • Initialization
      • Install the SDK Package
      • Overview
      • Version history
    • Python-SDK
      • EIP Instance
      • EipBP Instance
      • EIPGROUP Instance
      • EipTp Instance
      • Exception handling
      • Initialization
      • Install the SDK Package
      • Overview
      • Version history
  • Service Level Agreement (SLA)
    • EIP Service Level Agreement SLA
    • TBSP Service Level Agreement SLA
  • Typical Practices
    • Bring Your Own Overseas Public IP Address to the Cloud
    • IPv6 Public Network Access
    • Save Public Network Costs
    • TCP Port 25 Restriction Description
All documents
menu
No results found, please re-enter

EIP

  • API Reference
    • API function release records
    • API Service Domain Name
    • API Specifications
    • Appendix 1
    • Bandwidth Package Related Interfaces
      • Adjust the bandwidth of the bandwidth package
      • Create bandwidth package
      • Query bandwidth package details
      • Query bandwidth package list information of users
      • Release bandwidth package
      • Update the automatic release time of the bandwidth package
      • Update the name of the bandwidth package
    • DDoS Basic Protection Related Interfaces
      • Modify DDoS basic protection threshold
      • Query DDoS Basic Protection Attack Records
      • Query DDoS basic protection list
    • EIP Related Interfaces
      • Apply for EIP
      • Bind EIP
      • Disable EIP direct
      • EIP bandwidth scaling
      • EIP renewal has been enabled
      • Enable EIP direct
      • Query EIP list in bucket trash
      • Query EIP list
      • Release EIP
      • Release EIPs in the bucket trash
      • Renew EIP
      • Restore EIPs in the bucket trash
      • Selective release of EIP
      • Unbind EIP
      • Unsubscribe prepaid EIP
      • Update EIP Release Protection Switch
    • Error code
    • General Description
    • Inquiry Related
      • Bandwidth package price inquiry
      • EIP Inquiry
      • EIPGROUP Inquiry
      • Shared Traffic Package Inquiry
    • Interface Overview
    • Overview
    • Prerequisites for use
    • Shared Bandwidth Related Interfaces
      • Bandwidth scaling up for EIPGROUP
      • Create EIPGROUP
      • EIPGROUP IP count upgrade
      • EIPGROUP release
      • EIPGROUP renewal
      • EIPGROUP update
      • Migrate EIP from EIPGROUP
      • Migrate EIP into EIPGROUP
      • Query EIPGROUP details
      • Query the EIPGROUP list
      • Unsubscribe prepaid EIPGROUP
    • Shared Traffic Package Related Interfaces
      • Create a shared traffic package
      • Query shared traffic package details
      • Query shared traffic package list
    • TBSP Related Interfaces
      • Add Protection IP Allow List
      • Add Protocol Blocking
      • Add Region Blocking
      • Bind Protection Object
      • Close Protection IP Cleaning
      • Create TBSP
      • Delete Protection IP Allow List
      • Delete Protection Object
      • Delete Protocol Blocking
      • Delete Region Blocking
      • Modify Protection IP Cleaning Threshold
      • Modify Protection IP Protection Level
      • Open Protection IP Cleaning
      • Query Protection IP Allow List
      • Query Protection IP Cleaning Threshold List
      • Query Protocol Blocking List
      • Query Region Blocking List
      • Query TBSP Details
      • Query TBSP List
      • TBSP Capacity dilatation
      • TBSP renew
  • FAQs
    • Billing class
    • Configuration
    • Consultation
    • Security class
  • Function Release Records
  • Operation guide
    • Address pool
    • Bandwidth package
      • Bandwidth scale-up package
      • Cross-border acceleration package
    • Certification
    • DDoS standard protection
    • EIP Instance
      • Create instance
      • EIP Direct Connect
      • IPv6 Termination
      • Manage Alarms
      • Operation Instance
      • Shift Charge
      • View monitoring
    • EIP Self-Service Diagnostics
      • EIP Instance Diagnosis
    • EIPGROUP
      • Bind cloud resources
      • Manage Shared Bandwidth
      • Purchase Shared Bandwidth
      • View monitoring
    • High Defense EIP
    • Identity and access management
    • Recycle bin
    • Shared traffic package
      • Purchase Shared Traffic Package
      • View Shared Traffic Package
    • Tag Management
    • Traffic Burst Service Package
      • Instance management
      • Monitor alarm
      • Protection Configuration
    • Unblocking Center
  • Product Description
    • Application scenarios
    • Product advantages
    • Product Introduction
    • Usage restrictions
  • Product pricing
    • Bandwidth Package Billing
    • EIP Instance Billing
    • EIPGROUP Billing
    • Shared Traffic Package Billing
    • TBSP Billing
  • SDK
    • GO-SDK
      • DDoS Instance
      • EIP Instance
      • EipBp Instance
      • EIPGROUP Instance
      • EipTp Instance
      • Exception handling
      • Initialization
      • Install the SDK Package
      • Overview
    • Java-SDK
      • EIP Instance
      • EipBP Instance
      • EIPGROUP Instance
      • EipTp Instance
      • Exception handling
      • Initialization
      • Install the SDK Package
      • Overview
      • Version history
    • PHP-SDK
      • EIP Instance
      • EipBP Instance
      • EIPGROUP Instance
      • Exception handling
      • Initialization
      • Install the SDK Package
      • Overview
      • Version history
    • Python-SDK
      • EIP Instance
      • EipBP Instance
      • EIPGROUP Instance
      • EipTp Instance
      • Exception handling
      • Initialization
      • Install the SDK Package
      • Overview
      • Version history
  • Service Level Agreement (SLA)
    • EIP Service Level Agreement SLA
    • TBSP Service Level Agreement SLA
  • Typical Practices
    • Bring Your Own Overseas Public IP Address to the Cloud
    • IPv6 Public Network Access
    • Save Public Network Costs
    • TCP Port 25 Restriction Description
  • Document center
  • arrow
  • EIP
  • arrow
  • API Reference
  • arrow
  • Appendix 1
Table of contents on this page
  • Definition of model object
  • EipModel
  • RecycleEipModel
  • EipGroupModel
  • EipMoveOutModel
  • TbspModel
  • TbspIpCleanModel
  • TbspIpWhitelistModel
  • TbspAreaBlockingModel
  • TbspProtocolBlockingModel
  • TbspProtocolPortModel
  • TbspIpModel
  • TbspAttackRecordModel
  • DdosModel
  • DdosAttackRecordModel
  • TagModel
  • Type code definition
  • instanceType
  • eipInstanceType
  • Status code definitions
  • eipStatus
  • Order information definition
  • Billing
  • Reservation

Appendix 1

Updated at：2025-10-16

Definition of model object

EipModel

Parameter name Types Description
name String EIP name
eip String EIP address, in dotted decimal notation
eipId String EIP ID
status eipStatus EIP status
eipInstanceType eipInstanceType EIP instance type
instanceType instanceType Bound instance type (empty if EIP is unbound)
instanceId String Instance ID, with the value being empty if the EIP is unbound
shareGroupId String EIPGROUP ID, with the value being empty for regular EIPs
defaultDomesticBandwidth int Default cross-border acceleration bandwidth, only available in the Hong Kong region, in Mbps
bandwidthInMbps int Public network bandwidth, in Mbps
bwShortId String Bandwidth package ID
bwBandwidthInMbps int Total bandwidth of bandwidth package, in Mbps
domesticBwShortId String Cross-border acceleration package ID
domesticBwBandwidthInMbps int Cross-border acceleration package bandwidth, in Mbps
paymentTiming string Payment time: Prepaid and Postpaid.
billingMethod string Charge type: ByTraffic (traffic-based) and ByBandwidth (bandwidth-based, only applicable for postpay products)
createTime string Creation time
expireTime string Expiration time (only prepaid products populate this field)
region string The region to which the current EIP belongs
routeType string EIP Internet connection type
tags List<[TagModel](EIP/API Reference/Appendix 1.md#TagModel)> Collection of tags bound
deleteProtect Boolean Whether to enable release protection

RecycleEipModel

Parameter name Type Description
name String EIP name
eip String EIP address, in dotted decimal notation
eipId String EIP ID
status eipStatus EIP status
routeType String EIP Internet connection type
bandwidthInMbps int Public network bandwidth, in Mbps
paymentTiming String Payment time: Prepaid and Postpaid.
billingMethod String Charge type: ByTraffic, ByBandwidth, etc.
recycleTime String EIP recycling time
scheduledDeleteTime String EIP scheduled deletion time

EipGroupModel

Parameter name Types Description
name String EIPGROUP name
status eipStatus EIPGROUP status
id String EIPGROUP ID
bandwidthInMbps int EIPGROUP bandwidth value, in Mbps
defaultDomesticBandwidth int Default cross-border acceleration bandwidth, only available in the Hong Kong region, in Mbps
bwShortId String Bandwidth package ID
bwBandwidthInMbps int Total bandwidth of bandwidth package, in Mbps
domesticBwShortId String Cross-border acceleration package ID
domesticBwBandwidthInMbps int Cross-border acceleration package bandwidth, in Mbps
paymentTiming string Payment time: Prepaid and Postpaid.
billingMethod string Charge type: ByBandwidth (by bandwidth) or ByPeak95 (95th percentile billing)
createTime string Creation time
expireTime string Expiration time (only prepaid products populate this field)
region string Region to which the EIPGROUP belongs
routeType string EIPGROUP Internet connection type
tags List<[TagModel](EIP/API Reference/Appendix 1.md#TagModel)> Collection of tags bound
eips List<[EipModel](EIP/API Reference/Appendix 1.md#EipModel)> IPv4 EIP information in EIPGROUP
eipv6s List<[EipModel](EIP/API Reference/Appendix 1.md#EipModel)> IPv6 EIP information in EIPGROUP

EipMoveOutModel

Parameter name Types Whether required Description
eip String Yes IP address of EIP to be removed
bandwidthInMbps int No EIP Bandwidth after removal (in Mbps; required only for native EIPs removed from EIPGROUP)
billing Billing No Charge information for the EIP after removal (only postpay is supported; this parameter is required only for native EIPs removed from the EIPGROUP)

TbspModel

Parameter name Type Description
name String Name of the TBSP
id String ID of the TBSP
defenseLineType String Internet connection type of the TBSP
defenseCountQuota Int Capacity of the TBSP
ipList List<TbspIpModel> List of IPs bound to the TBSP
ipTotalCount Int Count of IPs bound to the TBSP
autoRenewSwitch Int Whether TBSP enables auto-renewal (1 indicates enabled)
productStatus String Status of the TBSP
createTime String Creation time of the TBSP
expireTime String Expiration time of the TBSP
defenseEnable Int Protection capability of the TBSP, with 0 indicating best-effort protection
attackingRecordList List<TbspAttackRecordModel> Attack record list of the TBSP
attackingRecordTotalCount Int Total attack records of the TBSP

TbspIpCleanModel

Parameter name Type Description
ip String IP address of TBSP protection object
eipName String IP name of TBSP protection object
eipId String EIP ID of TBSP protection object
thresholdType String Type of TBSP cleaning threshold, including bandwidth (upper limit), auto (smart), and manual
ipCleanMbps Int Cleaning threshold for traffic bandwidth per second, in Mbps
ipCleanPps Int Cleaning threshold in packets per second, in pps
productStatus String Status of the TBSP
turnOffBeginTime String Start time for disabling protection IP cleaning
turnOnEndTime String End time for disabling protection IP cleaning

TbspIpWhitelistModel

Parameter name Type Description
ip String IP address of TBSP protection object
whitelistId String TBSP IP allow list ID
ipCidr String TBSP IP allow list segments (in complete IP address format or IP segment format)

TbspAreaBlockingModel

Parameter name Type Description
ip String IP address of TBSP protection object
blockArea String TBSP protection object block regions, including the Chinese Mainland (continent) as well as overseas and Hong Kong, Macau, and Taiwan regions (overseas)
blockBeginTime String TBSP protection object region block start time
blockEndTime String TBSP protection object region block end time
blockType String TBSP protection object region block type

TbspProtocolBlockingModel

Parameter name Type Description
ip String IP address of TBSP protection object
protocolPortList List<[TbspProtocolPortModel](EIP/API Reference/Appendix 1.md#TbspProtocolPortModel)> TBSP protocol blocked port list information

TbspProtocolPortModel

Parameter name Type Description
type String TBSP block protocol types, including icmp, tcp, and udp
portBegin Int Port blocking start value for TBSP
portEnd Int Port blocking end value for TBSP

TbspIpModel

Parameter name Type Description
ip String Bind TBSP to IP address of protection object
status String Bind TBSP to operation status of protection object

TbspAttackRecordModel

Parameter name Type Description
ip String Address of attacked IP of TBSP
startTime String Attack start time

DdosModel

Parameter name Type Description
ip String Public IP address
status String Basic protection status, including normal, flush (cleaning), and blackhole (blocked)
bindInstanceType String Public IP bound instance type (empty if unbound)
bindInstanceId String Public IP bound instance ID (empty if unbound)
ipCleanMbps Long Cleaning threshold for traffic bandwidth per second, in Mbps
ipCleanPps Long Cleaning threshold in packets per second, in pps
thresholdType String Type of cleaning threshold, including bandwidth (upper limit), auto (smart), and manual
maximumThreshold Long Maximum protection threshold, in MB

DdosAttackRecordModel

Parameter name Type Description
ip String Public IP address
startTime String Attack start UTC time
endTime String Attack end UTC time
attackType List Attack type
attackPeakMbps Long Attack peak traffic bandwidth per second, in Mbps
attackPeakPps Long Attack peak packets per second, pps
attackPeakQps Long Attack peak queries per second, pqs
attackStatus String Attack status, including underway and ended

TagModel

Parameter name Types Description
tagKey String The key of the tag, which main contain uppercase and lowercase letters, numbers, Chinese characters, and special characters-_ /., with a length of 1-65.
tagValue String The value of the tag, which main contain uppercase and lowercase letters, numbers, Chinese characters, and special characters-_ /., with a length of 0-65.

Type code definition

instanceType

Types Description
BCC BCC instance type
BBC BBC instance type
DCC DCC instance type
ENI Elastic network interface instance type
BLB BLB instance type
VPN VPN instance type
NAT NAT instance type

eipInstanceType

Types Description
normal Standard EIP type
shared EIP in EIPGROUP

Status code definitions

eipStatus

Status Description
creating Creating
available Available
binded Bound
binding Binding in progress
unbinding Unbinding in progress
updating Updating
paused Suspended
unavailable Temporarily unavailable, under repair

Order information definition

Billing

Status Types Description
paymentTiming string Payment time: Prepaid and Postpaid.
billingMethod string Charge Type: ByTraffic, ByBandwidth, ByPeak95 (only supported by postpay EIPGROUP)
reservation Reservation Reserved information, not required when payment method is Postpay, but must be set when it is Prepay

Reservation

Status Types Description
reservationLength int Duration: [1,2,3,4,5,6,7,8,9,12,24,36]
reservationTimeUnit string Time unit: month - currently only monthly payment is supported

Previous
API Specifications
Next
Bandwidth Package Related Interfaces