All documents

No results found, please re-enter

VPC VPC

Appendix

Updated at：2025-10-16

Vpc

Parameter name	Types	Description
vpcId	String	VPC ID
name	String	Name
cidr	String	Network segment and subnet mask
ipv6Cidr	String	IPv6 segment of the VPC
description	String	Description
isDefault	Boolean	Whether it is the default VPC: true for yes, false for no
relay	Boolean	Whether enable VPC relay: true for yes, false for no
secondaryCidr	List<String>	Secondary segment CIDR list of the VPC
tags	List<TagModel>	Collection of tags bound to VPC

ShowVpcModel

Parameter name	Types	Description
vpcId	String	VPC ID
name	String	Name
cidr	String	Network segment and subnet mask
ipv6Cidr	String	IPv6 segment of the VPC
description	String	Description
isDefault	Boolean	Whether it is the default VPC: true for yes, false for no
relay	Boolean	Whether enable VPC relay: true for yes, false for no
subnets	List<Subnet>	Subnets contained in the VPC
secondaryCidr	List<String>	Secondary segment CIDR list of the VPC
tags	List<TagModel>	Collection of tags bound to VPC

VpcPrivateIpAddress

Parameter name	Types	Description
cidr	String	Subnet CIDR to which it belongs
privateIpAddress	String	VPC intranet IP
privateIpAddressType	String	Type of VPC intranet IP
createdTime	String	Creation time

ResourceIp

Parameter name	Types	Description
ip	String	VPC intranet IP
resourceType	String	Product to which the VPC intranet IP belongs

Subnet

Parameter name	Types	Description
subnetId	String	Subnet ID
name	String	Subnet name
zoneName	String	Availability zone name
cidr	String	Subnet CIDR
ipv6Cidr	String	IPv6 segment of the subnet
vpcId	String	ID of VPC to which the subnet belongs
subnetType	String	Subnet type: "BCC", "BCC_NAT", "BBC"
description	String	Description
availableIp	Integer	Available IP count in the subnet
availableUnreservedIp	Integer	Available IP count in the subnet excluding reserved network segments
createdTime	String	Creation time of the subnet
tags	List<TagModel>	List of tags bound to the subnet

SubnetDetail

Parameter name	Types	Description
subnetId	String	Subnet ID
name	String	Subnet name
zoneName	String	Availability zone name
cidr	String	Subnet CIDR
ipv6Cidr	String	IPv6 segment of the subnet
vpcId	String	ID of VPC to which the subnet belongs
subnetType	String	Subnet type: "BCC", "BCC_NAT", "BBC"
description	String	Description
availableIp	Integer	Available IP count in the subnet
availableUnreservedIp	Integer	Available IP count in the subnet excluding reserved network segments
createdTime	String	Creation time of the subnet
tags	List<TagModel>	List of tags bound to the subnet

IpReserve

Parameter name	Types	Description
ipReserveId	String	ID of reserved network segment
subnetId	String	Subnet ID where the reserved network segment is located
ipCidr	String	IP or CIDR of reserved network segment
ipVersion	String	IP version of reserved network segment
description	String	Description of reserved network segment
createdTime	String	Instance creation time of reserved network segment
updatedTime	String	Instance update time of reserved network segment

RouteRule

Parameter name	Types	Description
routeRuleId	String	Routing rule ID
routeTableId	String	Route table ID
sourceAddress	String	Source network segment
destinationAddress	String	Destination segment
nexthopId	String	Next hop ID. This field can be left empty when nexthopType is a local gateway
nexthopType	String	Route type. The BCC type is "custom"; the VPN type is "vpn"; the NAT type is "nat"; the dedicated gateway type is "dcGateway"; the peering connections type is "peerConn"; the IPv6 gateway type is "ipv6gateway"; the system default type is "sys". VPC automatically generates a default routing rule for each subnet. Such type of routing rule features an empty ID and cannot be edited or deleted.
pathType	String	Single-line or multi-line routing. Value for single-line is "normal". Values for multi-line are ecmp, ha:active, or ha:standby.
description	String	Description

NextHop

Parameter name	Types	Description
nexthopId	String	ID of next hop
nexthopType	String	Route type, currently supports only the dedicated gateway type: "dcGateway".
pathType	String	Multi-line mode. For load balancer, the value is ecmp. For active-standby mode, the values are ha:active and ha:standby, indicating primary and standby routes.

SecurityGroupModel

Parameter name	Types	Description
id	String	Security group ID
name	String	Name, which supports uppercase and lowercase letters, numbers, Chinese characters, and -_ /. special characters, starting with a letter and a length of 1-65.
desc	String	Description
vpcId	String	Virtual Private Cloud (VPC) ID
createdTime	String	Security group creation time
sgVersion	Long	Security group version number
rules	List<SecurityGroupRuleModel>	Security group rule
tags	List<TagModel>	Tag list bound to the security group

SecurityGroupRuleModel

Parameter name	Types	Description	Required or not
remark	String	Remarks	No
direction	String	Ingress/Egress: either ingress or egress.	Yes
ethertype	String	The network type, which can be either IPv4 or IPv6. When this value is null, it defaults to IPv4.	No
portRange	String	A port range can be specified, such as a single port like 80, with a default range of 1-65535 if no value is provided.	No
protocol	String	Protocol type: TCP, UDP, or ICMP. Defaults to "all" if no value is provided.	No
sourceGroupId	String	Source security group ID	No
sourceIp	String	Source IP address cannot be set at the same time as sourceGroupId.	No
destGroupId	String	Destination security group ID	No
destIp	String	Destination IP address cannot be set at the same time as destGroupId.	No
securityGroupId	String	Security group ID	No
securityGroupRuleId	String	ID of security group rules	No
createdTime	String	Security group rule creation time	No
updatedTime	String	Security group rule modification time	No

EnterpriseSecurityGroupModel

Parameter name	Types	Description
id	String	Enterprise security group ID
name	String	Name, which supports uppercase and lowercase letters, numbers, Chinese characters, and -_ /. special characters, starting with a letter and a length of 1-65.
desc	String	Description
createdTime	String	Enterprise security group creation time
updatedTime	String	Enterprise security group update time
rules	List<EnterpriseSecurityGroupRuleModel>	Enterprise security group rule
tags	List<TagModel>	List of tags bound to the enterprise security group

EnterpriseSecurityGroupRuleModel

Parameter name	Types	Description
remark	String	Remarks, with a length range of 1-255 characters.
direction	String	Ingress/Egress: either ingress or egress.
ethertype	String	The network type, which can be either IPv4 or IPv6. When this value is null, it defaults to IPv4.
portRange	String	Destination port range: Supports consecutive ports (e.g., "1-80") and individual ports (e.g., "80,7000,8000", separated by commas, with up to 15 individual values allowed). By default, the range is 1 to 65535 if left empty.
sourcePortRange	String	Source port range: Supports consecutive ports (e.g., "1-80") and individual ports (e.g., "80,7000,8000", separated by commas, with up to 15 individual values allowed). By default, the range is 1 to 65535 if left empty.
protocol	String	Protocol type: TCP, UDP, or ICMP. Defaults to "all" if no value is provided.
sourceIp	String	Source IP address. "all" indicates all.
destIp	String	Destination IP Address. "all" indicates all.
localIp	String	Local IP address: "all" represents all IP addresses.
remoteIpSet	String	Remote IP address group
remoteIpGroup	String	Remote IP address family
action	String	Allowed values: "allow" or "deny".
priority	Integer	Priority, with a value range of 1-1000.
enterpriseSecurityGroupRuleId	String	Enterprise security group rule ID
createdTime	String	Enterprise security group rule creation time
updatedTime	String	Enterprise security group rule modification time

AclEntry

Parameter name	Types	Description
subnetId	String	Subnet ID
subnetName	String	Subnet name
subnetCidr	String	Subnet CIDR
aclRules	List<AclRule>	Collection of ACL rules

AclRule

Parameter name	Types	Description
id	String	ACL rule ID
subnetId	String	Subnet ID
description	String	Remarks
protocol	String	Protocol, including all, tcp, udp, icmp
sourceIpAddress	String	Source IP (can be "all")
destinationIpAddress	String	Destination IP (can be "all")
sourcePort	String	Source port, e.g., 1-65535, or 8080
destinationPort	String	Destination port, e.g., 1-65535 or 8080
position	String	Priority: Ranges from 1 to 5000. Must not duplicate existing entries. Lower values indicate higher priority. Rules are matched in descending priority order.
direction	String	Rule ingress: ingress, rule egress: egress
ipVersion	Integer	ACL rule version: 4 represents IPv4, and 6 represents IPv6.
action	String	Policy, including allow and deny

AclRuleRequest

Parameter name	Types	Whether required	Parameter location	Description
subnetId	String	Yes	RequestBody	Subnet ID
description	String	No	RequestBody	Remarks
protocol	String	Yes	RequestBody	Protocol, including all, tcp, udp, icmp
sourceIpAddress	String	Yes	RequestBody	Source IP
destinationIpAddress	String	Yes	RequestBody	Destination IP
sourcePort	String	Yes	RequestBody	Source port, e.g., 1-65535, or 8080
destinationPort	String	Yes	RequestBody	Destination port, e.g., 1-65535 or 8080
position	Integer	Yes	RequestBody	Priority: Ranges from 1 to 5000. Must not duplicate existing entries. Lower values indicate higher priority. Rules are matched in descending priority order.
direction	String	Yes	RequestBody	Rule ingress: ingress, rule egress: egress
ipversion	Integer	No	RequestBody	Defaults to 4. If adding an IPv6 rule, the value must be set to 6.
action	String	Yes	RequestBody	Policy, including allow and deny

Billing

Parameter name	Types	Description
paymentTiming	String	Payment time: prepaid and postpaid. Required for new orders, not required for renewed orders
reservation	Reservation	Reserved information, not required when payment method is Postpay, but must be set when it is Prepay

Reservation

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

PeerConn

Parameter name	Types	Description
peerConnId	String	ID of peering connection
role	String	Peering connections role: initiator (source), acceptor (destination)
status	PeerConnStatus	Status for peering connection
bandwidthInMbps	String	Bandwidth of peering connection
description	String	Remark for peering connection
localIfId	String	ID of local API for peering connection
localIfName	String	Name of local API for peering connection
localVpcId	String	ID of local VPC for peering connection
localRegion	String	Local region of peering connection
peerVpcId	String	ID of peer VPC for peering connection
peerRegion	String	Peer region of peering connection
peerAccountId	String	Peer account ID of the peering connection
paymentTiming	String	Peering connections billing type
dnsStatus	DnsStatus	DNS synchronization status
createdTime	String	Creation time of peering connection
expiredTime	String	Expiration time (only prepaid products populate this field)

PeerConnStatus

Parameter name	Types	Description
creating	String	Creating
consulting	String	Negotiating
consult_failed	String	Negotiation failed
active	String	Available
down	String	Unavailable
starting	String	Starting
stopping	String	Stopping
deleting	String	Deleting
deleted	String	Deleted
expired	String	Expired
error	String	Exception
updating	String	Updating

DnsStatus

Parameter name	Types	Description
close	String	Disable synchronization
wait	String	Waiting for synchronization
syncing	String	Synchronizing
open	String	Enable synchronization
closing	String	Synchronization being disabled

NAT

Parameter name	Types	Description
id	String	NAT gateway ID
name	String	NAT (Network Address Translation) name
natType	String	NAT gateway type: "enhanced" indicates the enhanced type, "normal" indicates the normal type
vpcId	String	ID of VPC to which the NAT gateway belongs
spec	String	NAT gateway sizes include small (supporting up to 5 public IPs), medium (supporting up to 10 public IPs), and large (supporting up to 15 public IPs). Applicable only to standard NAT gateways
eips	List<String>	List of IP addresses for the Snat EIP bound to the NAT gateway
dnatEips	List<String>	List of IP addresses for the Dnat EIP bound to the NAT gateway
bindEips	List<String>	List of IP addresses of EIPs bound to the NAT gateway, applicable only to enhanced NAT gateways
status	NatStatus	Status of the NAT gateway
paymentTiming	String	Bill type: prepaid, postpaid
expiredTime	String	Expiration time
createTime	String	Creation time

NatStatus

Status	Description
active	Running
updating	Updating
unconfigured	Not configured
down	Unavailable
building	Creating
error	Abnormal status
deleting	Deleting
deleted	Deleted
starting	Starting
configuring	Configuring
rebooting	Restarting
stopping	Stopping

SnatRule

Parameter name	Types	Description
ruleId	String	Rule ID
ruleName	String	Rule name, which supports uppercase and lowercase letters, numbers, and special characters such as -, _, / and ., starting with a letter, with a length of 1-65.
publicIpsAddress	List<String>	List of public IPs, associated with EIPs on NAT gateway SNAT or IPs in EIPGROUP
sourceCIDR	String	Intranet IP/network segment
status	String	Rule status

DnatRule

Parameter name	Types	Description
ruleId	String	Rule ID
ruleName	String	DNAT rule name, which supports uppercase and lowercase letters, numbers, and special characters such as -, _, / and ., starting with a letter, with a length of 1-65.
publicIpAddress	String	Public IP, associated with EIPs on NAT gateway DNAT or IP in EIPGROUP
privateIpAddress	String	Internal IP address
protocol	String	Protocol, supporting TCP, UDP, all
publicPort	String	Public IP port (1-65535)
privatePort	String	Intranet IP port (1-65535)
status	String	Rule status
privatePortRange	String	Intranet port range
publicPortRange	String	Public port range

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.

Vpn

Parameter name	Types	Description
vpnId	String	VPN ID
vpnName	String	Name
type	String	Gateway type, value range: [IPSec, SSL]
description	String	Description
status	String	VPN status: active, building, and unconfigured
expiredTime	String	Expiration time
paymentTiming	String	Bill type
eip	String	Public IP address
maxConnection	Integer	Maximum count of client connections for SSL-VPN
bandwidthInMbps	Integer	EIP bandwidth
vpcId	String	VPC ID
vpnConnNum	Integer	Tunnel count
vpnConns	List<VpnConn>	List of VPN tunnels
sslVpnServer	SslVpnServer	SSL-VPN server
deleteProtect	Boolean	Whether to enable release protection
tags	List<TagModel>	Collection of tags bound to VPN
createTime	String	Creation time

VpnConn

Parameter name	Types	Description
vpnId	String	VPN ID
vpnConnId	String	Tunnel ID
vpnConnName	String	Tunnel name
localIp	String	Local IP
secretKey	String	Shared secret key
localSubnets	List<String>	List of local network CIDRs
remoteIp	String	Public IP of peer VPN gateway
remoteSubnets	List<String>	List of peer network CIDRs
description	String	Description
status	String	VPN tunnel status
createdTime	String	Creation time
healthStatus	String	Connectivity status
ikeConfig	IkeConfig	IKE configuration
ipsecConfig	IpsecConfig	IPSec configuration

SslVpnServer

Parameter name	Types	Description
vpnId	String	VPN ID
sslVpnServerId	String	SSL-VPN server ID
sslVpnServerName	String	SSL-VPN server name
interfaceType	String	SSL-VPN server API type
status	String	SSL-VPN server status
localSubnets	List<String>	List of local network CIDRs
remoteSubnet	String	Client network CIDRs
clientDns	String	Client DNS address
maxConnection	Integer	Maximum count of client connections for SSL-VPN

SslVpnUserVo

Parameter name	Types	Description
userName	String	Username
userId	String	User ID
description	String	Description

SslVpnUser

Parameter name	Types	Whether required	Parameter location	Description
userName	String	Yes	RequestBody	User name, which supports uppercase and lowercase letters, numbers and -_ /. special characters, starting with a letter, with a length of 1-65.
password	String	Yes	RequestBody	Password: 8-17 characters; it must contain English letters, numbers, and symbols (limited to !@#$%^*()_) simultaneously
description	String	No	RequestBody	Description

IkeConfig

Parameter name	Types	Description
ikeVersion	String	Version, valid range: v1/v2
ikeMode	String	Negotiation mode, value range: main/aggressive
ikeEncAlg	String	Encryption algorithm, value range: aes/aes192/aes256/3des
ikeAuthAlg	String	Certification algorithm, value range: sha1/md5
ikePfs	String	DH Group, value range: group2/group5/group14/group24
ikeLifeTime	String	SA lifecycle, value range: 60-86400

IpsecConfig

Parameter name	Types	Description
ipsecEncAlg	String	Encryption algorithm, value range: aes/aes192/aes256/3des
ipsecAuthAlg	String	Certification algorithm, value range: sha1/md5
ipsecPfs	String	DH Group, value range: group2/group5/group14/group24
ipsecLifetime	String	SA lifecycle, value range: 180-86400

Eni

Parameter name	Types	Description
eniId	String	Elastic network interface ID
name	String	Name of elastic network interface
zoneName	String	Availability zone to which the elastic network interface belongs
description	String	Description of elastic network interface
instanceId	String	ID of the mounted cloud host
macAddress	String	MAC address of the elastic network interface
vpcId	String	VPC ID of the elastic network interface
subnetId	String	Subnet ID of the elastic network interface
status	String	Elastic network interface status
privateIpSet	List<PrivateIP>	IPv4 IP collection of the elastic network interface
ipv6PrivateIpSet	List<PrivateIP>	IPv6 IP collection of the elastic network interface

HaVip

Parameter name	Types	Description
haVipId	String	High-availability virtual IP address ID
name	String	High-availability virtual IP address name
description	String	High-availability virtual IP address description
vpcId	String	VPC ID where the high-availability virtual IP address is located
subnetId	String	Subnet ID where the high-availability virtual IP address is located
status	String	High-availability virtual IP address status: "available" for available, "bound" for bound to instances
privateIpAddress	String	Intranet IP address of the high-availability virtual IP address
publicIpAddress	String	Public IP address of the high-availability virtual IP address
createdTime	String	Creation time of the high-availability virtual IP address

HaVipBindedInstance

Parameter name	Types	Description
instanceId	String	Bound instance ID
instanceType	String	Type of bound instance, with "SERVER" indicating cloud server (BCC/BBC/DCC), and "ENI" indicating elastic network interface
master	Boolean	Active-standby identifier, with “true” indicating “active” and “false” indicating “standby”

Endpoint

Parameter name	Types	Description
endpointId	String	Service network interface card ID
name	String	Name of the service network interface card
ipAddress	String	Service network interface card IP
status	String	Service network interface card status, value range: available/unavailable, indicating mountable/unmountable, respectively
service	String	Service-specific domain name
subnetId	String	Subnet ID
description	String	Description
createTime	String	Creation time
vpcId	String	VPC ID
productType	String	Payment type

PrivateIP

Parameter name	Types	Description
publicIpAddress	String	Public IP address of the elastic network interface, i.e., EIP address
primary	Boolean	Whether it is the primary IP address
privateIpAddress	String	Intranet IP address of the elastic network interface

EgressOnlyRule

Parameter name	Types	Description
egressOnlyRuleId	String	ID of the egress-only policy
cidr	String	CIDR of the egress-only policy

RateLimitRule

Parameter name	Types	Description
rateLimitRuleId	String	ID of the IPv6 bandwidth limiting policy
ipv6Address	String	IPv6 address of bandwidth limiting
ingressBandwidthInMbps	Integer	Ingress bandwidth
egressBandwidthInMbps	Integer	Egress bandwidth

DnatRuleRequest

Parameter name	Types	Description
ruleName	String	Name, which supports uppercase and lowercase letters, numbers, and special characters such as -, , _, / and ., starting with a letter, with a length of 1-65.
publicIpAddress	String	Public IP, associated with EIPs on NAT gateway DNAT or IP in EIPGROUP
privateIpAddress	String	Internal IP address
protocol	String	Protocol, supporting TCP, UDP, all
publicPort	Integer	Public port (1-65535), valid for TCP/UDP protocols and unavailable to be specified simultaneously with port ranges
privatePort	Integer	Intranet port (1-65535), valid for TCP/UDP protocols and unavailable to be specified simultaneously with port ranges
publicPortRange	String	Public port range (80-90), valid for TCP/UDP protocols and unavailable to be specified simultaneously with a single port
privatePortRange	String	Intranet port range (80-90), valid for TCP/UDP protocols and unavailable to be specified simultaneously with a single port

SnatRuleRequest

Parameter name	Types	Description
ruleName	String	Name, which supports uppercase and lowercase letters, numbers, and special characters such as-, , _, / and., starting with a letter, with a length of 1-65.
publicIpsAddress	List	List of public IPs, associated with EIPs on NAT gateway SNAT or IPs in EIPGROUP
sourceCIDR	String	Intranet IP/network segment

EtGateway

Parameter name	Types	Description
etGatewayId	String	Dedicated gateway ID
name	String	Dedicated gateway name
status	String	Dedicated gateway status
speed	Integer	Egress bandwidth
createTime	String	Creation time
description	String	Dedicated gateway description
vpcId	String	Virtual network ID
etId	String	Dedicated line ID
channelId	String	Dedicated channel ID
localCidrs	List	IPv4 cloud network
enableIpv6	Integer	Whether the IPv6 function is enabled, 1 for yes and 0 for no
ipv6LocalCidrs	List	IPv6 cloud network
tags	List<TagModel>	Collection of tags bound to dedicated gateway

Probe

Parameter name	Types	Description
probeId	String	Probe ID
description	String	Probe description
destIp	String	Destination address
destPort	Integer	Destination port
frequency	Integer	Probe frequency
name	String	Probe name
payload	String	Probe content entity
protocol	String	Probe type: Supports TCP, UDP, ICMP, and DNS.
sourceIps	List<String>	Probe source address
status	String	Status: active (available)
subnetId	String	ID of subnet to which it belongs
vpcId	String	ID of VPC to which it belongs

TemplateIpAddressInfo

Parameter name	Types	Description
ipAddress	String	Parameter template IP address, can be a specific IP address or CIDR block
description	String	Parameter template IP address, used for detailed description

IpSet

Parameter name	Types	Description
ipSetId	String	ID of the IP address group
name	String	Name of the IP address group
description	String	Description of the IP address group
ipVersion	String	ipVersion, value: IPv4 or IPv6
ipAddressInfo	List<TemplateIpAddressInfo>	Parameter template IP address information
bindedInstanceNum	Integer	Count of instances bound to the IP address group

IpCollectionBindedInstance

Parameter name	Types	Description
instanceId	String	ID of instance bound to the parameter template
instanceType	String	Type of instance bound to the parameter template (currently only "ESG" is supported, representing enterprise security group)

IpGroup

Parameter name	Types	Description
ipGroupId	String	ID of the IP address family
name	String	Name of the IP address family
description	String	Description of the IP address family
ipVersion	String	ipVersion, value: IPv4 or IPv6
ipSetIds	List<String>	List of associated IP address group IDs
bindedInstanceNum	Integer	Count of instances bound to the IP address family

GlrItem

Parameter name	Types	Description
glrId	String	Bandwidth limiting rule ID
ipVersion	String	IP protocol version, value set as "4"
name	String	Bandwidth limiting rule name
description	String	Description
serviceType	String	Service type: perrconn-peering connections et-dedicated gateway csn-cloud smart networks
subServiceType	String	Sub-service type, with available values for this field as follows when serviceType is csn: LOCAL instance bandwidth PEER_CLOUD inter-cloud connection PEER_EDGE cloud-edge connection
resourceId	String	Resource ID
direction	String	Traffic direction
cidr	String	CIDR
bandwidth	Integer	Bandwidth
enable	Boolean	Whether it is enabled
createdTime	String	Creation time
updatedTime	String	Modification time

Common Headers and Error Responses