参考数据类型

VPC请求字段

名称 位置 类型 是否必须 描述
region body String 地域。公共参数。
name body String VPC名称。
有效值:长度为2-128个字符,不能以特殊字符及数字开头,只可包含特殊字符中的".","_"或"-"。
cidr body String 取值范围:10.0.0.0/8~10.255.255.0/28或者172.16.0.0/12 ~ 172.31.255.0/28或者192.168.0.0/16 ~ 192.168.255.0/28
约束:必须是cidr格式,例如:192.168.0.0/16

VPC请求字段(Update VPC)

名称 位置 是否必须 描述
name body VPC名称。
有效值:长度为2-128个字符,不能以特殊字符及数字开头,只可包含特殊字符中的".","_"或"-"。
VpcId path VPC的ID

VPC返回字段

名称 位置 类型 描述
id body String VPC ID
name body String VPC名称。
有效值:长度为2-128个字符,不能以特殊字符及数字开头,只可包含特殊字符中的".","_"或"-"。
cidr body String 取值范围:10.0.0.0/8~10.255.255.0/28或者172.16.0.0/12 ~ 172.31.255.0/28或者192.168.0.0/16 ~ 192.168.255.0/28
约束:必须是cidr格式,例如:192.168.0.0/16
status body String VPC 状态。
取值范围:ACTIVE, DOWN, BUILD or ERROR
subnets body String 关联的子网ID
routetableId body string 路由表ID
isdefault body Boolean 是否默认。 true 默认 false非默认
created_at body String 创建时间

子网请求字段

名称 位置 类型 是否必须 描述
name body String 子网名称。
有效值:长度为2-128个字符,不能以特殊字符及数字开头,只可包含特殊字符中的".","_"或"-"。
vpc body VPC 子网所属的VPC对象
ip_version body integer IP协议类型。 4代表IPV4,6代表IPV6. 默认值:4
gateway_ip body String 子网的网关IP。如果不指定,系统将从子网的CIDR中自动分配一个IP作为网关。
cidr body String 子网网段。 有效值:在VPC的cidr之中,且不能与当前VPC中存在的子网网段重叠。
enable_dhcp body boolean 子网是否开启dhcp功能 取值范围:true(开启),false(关闭) 约束:不填时默认为true
availability_zone body String 子网所在的可用分区标识 约束:系统存在的可用分区标识
availableIpAddressCount body Integer 可用IP数
IpAddressCount body Integer 子网IP总数

子网请求字段(Update Subnet)

名称 位置 类型 是否必须 描述
name body String 子网名称。 有效值:长度为2-128个字符,不能以特殊字符及数字开头,只可包含特殊字符中的".","_"或"-"。
SubnetId path String 子网的ID
Dns1 body String DNS服务地址1
Dns2 body String DNS服务地址2

子网返回字段

名称 位置 类型 描述
Id body String 子网ID。
name body String 子网名称。 有效值:长度为2-128个字符,不能以特殊字符及数字开头,只可包含特殊字符中的".","_"或"-"。
vpc body VPC 子网所属的VPC对象
ip_version body integer IP协议类型。
4代表IPV4,6代表IPV6. 默认值:4
gateway_ip body String 子网的网关IP。如果不指定,系统将从子网的CIDR中自动分配一个IP作为网关。
cidr body String 子网网段。
有效值:在VPC的cidr之中,且不能与当前VPC中存在的子网网段重叠。
IsDefault body Boolean 是否默认子网。
True 默认 false 非默认
created_at body string 子网创建时间。 UTC ISO8601 格式。
enable_dhcp body boolean 子网是否开启dhcp功能
取值范围:true(开启),false(关闭) 约束:不填时默认为true
availability_zone body String 子网所在的可用分区标识 约束:系统存在的可用分区标识
status body String 功能说明:子网的状态
取值范围:ACTIVE,DOWN,UNKNOWN,ERROR
availableIpAddressCount body Integer 可用IP数
totalIpAddressCount body Integer 子网IP总数

路由对象字段

名称 位置 类型 描述
id body String 路由表ID。
name body String 路由表名称。 默认为空。
routerType body String 路由列类型。 当前只有一个类型:”system(系统路由)“
vpcid body String 路由表所属的VPC ID
vpcname body String VPC名称。
routes body Array of Route 路由策略合集。
created_at body String 路由表创建时间。与VPC创建时间相同。 格式:UTC ISO8601

路由策略对象字段

名称 位置 类型 描述
destination body String 路由目的地址CIDR。
nexthop body String 路由下一跳。
nexthopTpye body String 下一跳类型。目前仅支持ECS(云服务器)。

安全组对象请求字段

名称 位置 类型 是否必须 描述
name body String 安全组名称。 有效值:长度为2-128个字符,不能以特殊字符及数字开头,只可包含特殊字符中的".","_"或"-"
description body String 安全组描述信息。

安全组对象返回字段

名称 位置 类型 描述
id body String 安全组ID。
name body String 安全组名称。
description body String 安全组描述
security_group_rules body Array of SecurityGroupRule 安全组规则
created_at body String 安全组创建时间。 格式; UTC ISO8601
isdefault body Boolean 是否是默认安全组,默认安全组不支持删除。
有效值:trul为默认,false为非默认。
默认值:false

安全组规则对象请求字段

名称 位置 类型 是否必须 描述
description body String 安全组规则描述。 约束:2-64个字符。
security_group_id body String 安全组规则所属的安全组ID。
direction body String 出入控制方向。 取值范围:egress,ingress
ethertype body String IP协议类型。
取值范围:IPv4,IPv6
默认值:IPV4
protocol body String 协议类型 取值范围:icmp,tcp,udp,and so on 约束:为null表示支持所有协议
port_range_min body Integer 取值范围:1~65535 功能说明:起始端口值 约束:不能大于port_range_max的值,为空表示所有端口,如果协议是icmp类型,取值范围参照安全组规则icmp协议名称对应关系表
port_range_max body Integer 取值范围:1~65535 2、功能说明:起始端口值 3、约束:不能小于port_range_min的值,为空表示所有端口,如果协议是icmp类型,取值范围参照安全组规则icmp协议名称对应关系表
remote_ip_prefix body String 远端IP地址,当direction是egress时为虚拟机访问端的地址,当direction是ingress时为访问虚拟机的地址 取值范围:IP地址,或者cidr格式

安全组规则对象返回字段

名称 位置 类型 描述
id body String 安全组规则ID。
description body String 安全组规则描述。 约束:2-64个字符。
security_group_id body String 安全组规则所属的安全组ID。
direction body String 出入控制方向。 取值范围:egress,ingress
ethertype body String IP协议类型。 取值范围:IPv4,IPv6
默认值:IPV4
protocol body String 协议类型 取值范围:icmp,tcp,udp,and so on 约束:为null表示支持所有协议
port_range_min body Integer 取值范围:1~65535 功能说明:起始端口值 约束:不能大于port_range_max的值,为空表示所有端口,如果协议是icmp类型,取值范围参照安全组规则icmp协议名称对应关系表
port_range_max body Integer 取值范围:1~65535 2、功能说明:起始端口值 3、约束:不能小于port_range_min的值,为空表示所有端口,如果协议是icmp类型,取值范围参照安全组规则icmp协议名称对应关系表
remote_ip_prefix body String 远端IP地址,当direction是egress时为虚拟机访问端的地址,当direction是ingress时为访问虚拟机的地址 取值范围:IP地址,或者cidr格式