私有网络VPC

    附录

    相关Model对象定义

    Vpc

    参数名称 类型 描述
    vpcId String vpc的id
    name String 名称
    cidr String 网段及子网掩码
    description String 描述
    isDefault Boolean 是否为默认VPC,true:是;false:否
    secondaryCidr List<String> vpc的辅助网段cidr列表
    tags List<TagModel> vpc绑定的标签集合

    ShowVpcModel

    参数名称 类型 描述
    vpcId String vpc的id
    name String 名称
    cidr String 网段及子网掩码
    description String 描述
    isDefault Boolean 是否为默认VPC,true:是;false:否
    subnets List<Subnet> VPC中包含的子网
    secondaryCidr List<String> vpc的辅助网段cidr列表
    tags List<TagModel> vpc绑定的标签集合

    Subnet

    参数名称 类型 描述
    subnetId String 子网id
    name String 子网名称
    zoneName String 可用区名称
    cidr String 子网cidr
    vpcId String 子网所属vpc的id
    subnetType String 子网类型,"BCC”、"BCC_NAT”、”BBC”
    description String 描述
    availableIp Integer 子网内可用ip数
    tags List<TagModel> 子网绑定的标签列表

    RouteRule

    参数名称 类型 描述
    routeRuleId String 路由规则id
    routeTableId String 路由表id
    sourceAddress String 源网段
    destinationAddress String 目标网段
    nexthopId String 下一跳id,当nexthopType是本地网关类型时,该字段可以为空
    nexthopType String 路由类型。Bcc类型是"custom";VPN类型是"vpn";NAT类型是"nat”;
    系统默认类型是"sys”,VPC为每个子网自动生成一条默认路由规则,该类型的路由规则id是空,不可编辑和删除。
    description String 描述

    AclEntry

    参数名称 类型 描述
    subnetId String 子网ID
    subnetName String 子网名称
    subnetCidr String 子网的CIDR
    aclRules List<AclRule> ACL规则集合

    AclRule

    参数名称 类型 描述
    id String ACL规则ID
    subnetId String 子网的ID
    description String 备注
    protocol String 协议,包括all tcp udp icmp
    sourceIpAddress String 源IP,可以为all
    destinationIpAddress String 目的IP,可以为all
    sourcePort String 源端口,例如1-65535,或8080
    destinationPort String 目的端口,例如1-65535,或8080
    position String 优先级 1-5000且不能与已有条目重复。数值越小,优先级越高,规则匹配顺序为按优先级由高到低匹配
    direction String 规则的入站ingress 规则的出站egress
    action String 策略,包括allow和deny

    AclRuleRequest

    参数名称 类型 是否必需 参数位置 描述
    subnetId String RequestBody参数 子网的ID
    description String RequestBody参数 备注
    protocol String RequestBody参数 协议,包括all tcp udp icmp
    sourceIpAddress String RequestBody参数 源IP
    destinationIpAddress String RequestBody参数 目的IP
    sourcePort String RequestBody参数 源端口,例如1-65535,或8080
    destinationPort String RequestBody参数 目的端口,例如1-65535,或8080
    position Integer RequestBody参数 优先级 1-5000且不能与已有条目重复。数值越小,优先级越高,规则匹配顺序为按优先级由高到低匹配
    direction String RequestBody参数 规则的入站ingress 规则的出站egress
    action String RequestBody参数 策略,包括allow和deny

    Billing

    参数名称 类型 描述
    paymentTiming String 付款时间,预支付(Prepaid)和后支付(Postpaid)
    reservation Reservation 保留信息,支付方式为后支付时不需要设置,预支付时必须设置

    Reservation

    参数名称 类型 描述
    reservationLength int 时长,[1,2,3,4,5,6,7,8,9,12,24,36]
    reservationTimeUnit String 时间单位,month,当前仅支持按月

    PeerConn

    参数名称 类型 描述
    peerConnId String 对等连接的ID
    role String 对等连接角色 initiator发起端 acceptor接收端
    status PeerConnStatus 对等连接状态
    bandwithInMbp String 对等连接的带宽
    description String 对等连接备注
    localIfId String 对等连接本端接口ID
    localIfName String 对等连接本端接口名称
    localVpcId String 对等连接本端VPC的ID
    localRegion String 对等连接本端区域
    peerVpcId String 对等连接对端VPC的ID
    peerRegion String 对等连接对端区域
    peerAccountId String 对等连接对端的账户ID
    paymentTiming String 对等连接的付费类型
    dnsStatus DnsStatus 对等连接的付费类型
    createdTime String 对等连接的创建时间
    expiredTime string 过期时间,只有预付费产品此参数才有值

    PeerConnStatus

    参数名称 类型 描述
    creating String 创建中
    consulting String 协商中
    consult_failed String 协商失败
    active String 可用
    down String 不可用
    starting String 启动中
    stopping String 停止中
    deleting String 删除中
    deleted String 已删除
    expired String 已到期
    error String 异常
    updating String 更新中

    DnsStatus

    参数名称 类型 描述
    close String 关闭同步
    wait String 等待同步
    syncing String 同步中
    open String 开启同步
    closing String 关闭同步中

    NAT

    参数名称 类型 描述
    id String NAT网关的ID
    name String NAT网关名称
    vpcId String NAT网关所属VPC的ID
    spec String NAT网关的大小,有small(最多支持绑定5个公网IP)、medium(最多支持绑定10个公网IP)、large(最多支持绑定15个公网IP)三种
    eips List NAT网关绑定的EIP的IP地址列表
    status natStatus NAT网关的状态
    paymentTiming String 付费方式 预付费Prepaid 后付费Postpaid
    expireTime String 过期时间

    natStatus

    状态 描述
    active 运行中
    updating 更新中
    unconfigured 未配置
    down 不可用
    building 创建中
    error 状态异常
    deleting 删除中
    deleted 已删除
    starting 启动中
    configuring 配置中
    rebooting 重启中
    stopping 停止中

    TagModel

    参数名称 类型 描述
    tagKey String 标签的键,可包含大小写字母、数字、中文以及-_ /.特殊字符,长度1-65
    tagValue String 标签的值,可包含大小写字母、数字、中文以及-_ /.特殊字符,长度0-65

    Vpn

    参数名称 类型 描述
    vpnId String vpn的id
    vpnName String 名称
    description String 描述
    status String vpn状态,active:可用,building:创建中,unconfigured:未配置
    expiredTime String 到期时间
    productType String 计费类型
    eip String 公网ip
    bandwidthInMbps Integer eip带宽
    vpcId String vpc的id
    vpnConnNum Integer 隧道数量
    vpnConns List<VpnConn> VPN隧道列表

    VpnConn

    参数名称 类型 描述
    vpnId String vpn的id
    vpnConnId String 隧道的id
    vpnConnName String 隧道的名称
    localIp String 本地ip
    secretKey String 共享秘钥
    localSubnets List<String> 本端网络cidr列表
    remoteIp String 对端VPN网关公网IP
    remoteSubnets List<String> 对端网络cidr列表
    description String 描述
    status String vpn隧道的状态
    createdTime String 创建时间
    healthStatus String 联通状态
    ikeConfig IkeConfig IKE配置
    ipsecConfig IpsecConfig IPSec配置

    IkeConfig

    参数名称 类型 描述
    ikeVersion String 版本,取值范围:v1/v2
    ikeMode String 协商模式,取值范围:main/aggressive
    ikeEncAlg String 加密算法,取值范围:aes/aes192/aes256/3des
    ikeAuthAlg String 认证算法,取值范围:sha1/md5
    ikePfs String DH分组,取值范围:group2/group5/group14/group24
    ikeLifeTime String SA生命周期,取值范围:60-86400

    IpsecConfig

    参数名称 类型 描述
    ipsecEncAlg String 加密算法,取值范围:aes/aes192/aes256/3des
    ipsecAuthAlg String 认证算法,取值范围:sha1/md5
    ipsecPfs String DH分组,取值范围:group2/group5/group14/group24
    ipsecLifetime String SA生命周期,取值范围:180-86400
    上一篇
    专线网关相关接口
    下一篇
    SDK