数据结构

最近更新时间:2025-02-21 02:11:49

我的收藏

AccessPolicy

策略信息

被如下接口引用:DescribeVpnGatewaySslServers。

名称 类型 描述
TargetCidr String 目的CIDR
示例值:178.16.0.0/16
VpnGatewayIdSslAccessPolicyId String 策略ID
示例值:vpnap-3a21cjeu
ForAllClient Integer 是否对所有用户都生效。1 生效 0不生效
示例值:0
UserGroupIds Array of String 用户组ID
示例值:['18b49e01-eaa8-4d85-9528-0f72fd7025e2']
UpdateTime String 更新时间
示例值:2023-12-10 12:00:00
Remark String Remark
示例值:remark-info

AccountAttribute

账户属性对象

被如下接口引用:DescribeAccountAttributes。

名称 类型 描述
AttributeName String 属性名
示例值:supported-platforms
AttributeValues Array of String 属性值
示例值:["VPC"]

Address

描述 EIP 信息

被如下接口引用:DescribeAddresses, DescribeIPv6Addresses, DescribeIp6Addresses。

名称 类型 描述
AddressId String EIPID,是EIP的唯一标识。
示例值:eip-ip9ongec
AddressName String EIP名称。
示例值:未命名
AddressStatus String EIP状态,包含'CREATING'(创建中),'BINDING'(绑定中),'BIND'(已绑定),'UNBINDING'(解绑中),'UNBIND'(已解绑),'OFFLINING'(释放中),'BIND_ENI'(绑定悬空弹性网卡)
示例值:UNBIND
AddressIp String 外网IP地址
示例值:100.10.1.1
InstanceId String 绑定的资源实例ID。可能是一个CVMNAT
示例值:ins-xxxxx
CreatedTime Timestamp ISO8601 创建时间。按照ISO8601标准表示,并且使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ
示例值:2021-05-19T08:37:53Z
NetworkInterfaceId String 绑定的弹性网卡ID
示例值:null
PrivateAddressIp String 绑定的资源内网ip
示例值:null
IsArrears Boolean 资源隔离状态。true表示eip处于隔离状态,false表示资源处于未隔离状态
示例值:false
IsBlocked Boolean 资源封堵状态。true表示eip处于封堵状态,false表示eip处于未封堵状态
示例值:false
IsEipDirectConnection Boolean eip是否支持直通模式。true表示eip支持直通模式,false表示资源不支持直通模式
示例值:false
AddressType String EIP 资源类型,包括CalcIP、WanIP、EIP和AnycastEIP、高防EIP。其中:CalcIP 表示设备 IP,WanIP 表示普通公网 IP,EIP 表示弹性公网 IP,AnycastEIP 表示加速 EIP,AntiDDoSEIP表示高防EIP。
示例值:EIP
CascadeRelease Boolean eip是否在解绑后自动释放。true表示eip将会在解绑后自动释放,false表示eip在解绑后不会自动释放
示例值:false
EipAlgType AlgType EIP ALG开启的协议类型。
InternetServiceProvider String 弹性公网IP的运营商信息,当前可能返回值包括"CMCC","CTCC","CUCC","BGP"
示例值:BGP
LocalBgp Boolean 是否本地带宽EIP
示例值:false
Bandwidth Integer 弹性公网IP的带宽值。注意,传统账户类型账户的弹性公网IP没有带宽属性,值为空。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
InternetChargeType String 弹性公网IP的网络计费模式。注意,传统账户类型账户的弹性公网IP没有网络计费模式属性,值为空。
注意:此字段可能返回 null,表示取不到有效值。
包括:
  • BANDWIDTH_PREPAID_BY_MONTH

  • 表示包月带宽预付费。


  • TRAFFIC_POSTPAID_BY_HOUR

  • 表示按小时流量后付费。


  • BANDWIDTH_POSTPAID_BY_HOUR

  • 表示按小时带宽后付费。


  • BANDWIDTH_PACKAGE

  • 表示共享带宽包。


    注意:此字段可能返回 null,表示取不到有效值。
    示例值:TRAFFIC_POSTPAID_BY_HOUR
    TagSet Array of Tag 弹性公网IP关联的标签列表。
    注意:此字段可能返回 null,表示取不到有效值。
    DeadlineDate Date 到期时间。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2024-10-06T07:48:30Z
    InstanceType String EIP绑定的实例类型。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:CVM
    Egress String 静态单线IP网络出口
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:center_egress1
    AntiDDoSPackageId String 高防包ID,当EIP类型为高防EIP时,返回EIP绑定的高防包ID.
    示例值:bgp-fod89fe8
    RenewFlag String 当前EIP是否自动续费,只有按月带宽预付费的EIP才会显示该字段,具体值示例如下:
  • NOTIFY_AND_MANUAL_RENEW:正常续费
  • NOTIFY_AND_AUTO_RENEW:自动续费
  • DISABLE_NOTIFY_AND_MANUAL_RENEW:到期不续费


  • 示例值:NOTIFY_AND_MANUAL_RENEW
    BandwidthPackageId String 当前公网IP所关联的带宽包ID,如果该公网IP未使用带宽包计费,则返回为空
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:bwp-ki2fa60h
    UnVpcId String 传统弹性公网IPv6所属vpc唯一ID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:vpc-xxxxxxxx
    DedicatedClusterId String CDC唯一ID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:cluster-gbo27yc4

    AddressChargePrepaid

    用于描述弹性公网IP的费用对象

    被如下接口引用:AllocateAddresses, InquiryPriceAllocateAddresses, InquiryPriceRenewAddresses, ModifyAddressInternetChargeType, RenewAddresses。

    名称 类型 必选 描述
    Period Integer 购买实例的时长,单位是月。可支持时长:1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36
    示例值:12
    AutoRenewFlag Integer 自动续费标志。0表示手动续费,1表示自动续费,2表示到期不续费。默认缺省为0即手动续费
    示例值:2

    AddressInfo

    IP地址模板信息

    被如下接口引用:CreateAddressTemplate, DescribeAddressTemplates, ModifyAddressTemplateAttribute。

    名称 类型 必选 描述
    Address String ip地址。
    示例值:2.2.2.2
    Description String 备注。
    示例值:desc
    UpdatedTime String 更新时间。
    示例值:2020-08-10 18:10:12

    AddressTemplate

    IP地址模板

    被如下接口引用:CreateAddressTemplate, DescribeAddressTemplates。

    名称 类型 描述
    AddressTemplateName String IP地址模板名称。
    示例值:name
    AddressTemplateId String IP地址模板实例唯一ID。
    示例值:ipm-7t9oijd0
    AddressSet Array of String IP地址信息。
    示例值:["2.2.2.2"]
    CreatedTime String 创建时间。
    示例值:2021-03-02 14:41:15
    UpdatedTime String 最后更新时间。
    示例值:2021-03-02 14:41:15
    AddressExtraSet Array of AddressInfo 带备注的IP地址信息。
    示例值:[{'Address': '2.2.2.2', 'Description': 'desc'}]
    TagSet Array of Tag 标签键值对。
    示例值:[{"Key": "key", "Value": "value"}]

    AddressTemplateGroup

    IP地址模板集合

    被如下接口引用:CreateAddressTemplateGroup, DescribeAddressTemplateGroups。

    名称 类型 描述
    AddressTemplateGroupName String IP地址模板集合名称。
    示例值:prod demo
    AddressTemplateGroupId String IP地址模板集合实例ID,例如:ipmg-dih8xdbq。
    示例值:ipmg-g1ogd8r2
    AddressTemplateIdSet Array of String IP地址模板ID。
    示例值:["ipm-7t9oijd0"]
    CreatedTime String 创建时间。
    示例值:2022-12-06 20:00:00
    UpdatedTime String 最后更新时间。
    示例值:2022-12-06 20:00:00
    AddressTemplateSet Array of AddressTemplateItem IP地址模板实例。
    示例值:[{"AddressTemplateId": "ipm-7t9oijd0", "AddressTemplateName": "prod demo"}]
    TagSet Array of Tag 标签键值对。
    示例值:[{"Key": "key", "Value": "value"}]

    AddressTemplateItem

    地址信息

    被如下接口引用:CreateAddressTemplateGroup, DescribeAddressTemplateGroups。

    名称 类型 必选 描述
    AddressTemplateId String IP地址模板ID
    示例值:ipm-7t9oijd0
    AddressTemplateName String IP模板名称,废弃字段。
    示例值:demo
    From String 废弃字段。
    示例值:192.168.1.10
    To String 废弃字段
    示例值:192.168.1.20
    Description String 备注。
    示例值:desc
    UpdatedTime String 最后更新时间。
    示例值:2020-08-10 18:10:12

    AddressTemplateSpecification

    IP地址模板

    被如下接口引用:CreateSecurityGroupPolicies, CreateSecurityGroupWithPolicies, DeleteSecurityGroupPolicies, DescribeSecurityGroupPolicies, DescribeSgSnapshotFileContent, ModifySecurityGroupPolicies, ReplaceSecurityGroupPolicies, ReplaceSecurityGroupPolicy。

    名称 类型 必选 描述
    AddressId String IP地址ID,例如:ipm-2uw6ujo6。
    示例值:ipm-2uw6ujo6
    AddressGroupId String IP地址组ID,例如:ipmg-2uw6ujo6。
    示例值:ipmg-2uw6ujo6

    AlgType

    ALG协议类型

    被如下接口引用:DescribeAddresses, DescribeIPv6Addresses, DescribeIp6Addresses。

    名称 类型 描述
    Ftp Boolean Ftp协议Alg功能是否开启
    示例值:true
    Sip Boolean Sip协议Alg功能是否开启
    示例值:true

    AssistantCidr

    VPC辅助CIDR信息。

    被如下接口引用:CreateAssistantCidr, CreateVpc, DescribeAssistantCidr, DescribeVpcs, ModifyAssistantCidr。

    名称 类型 描述
    VpcId String VPC实例ID。形如:vpc-6v2ht8q5
    示例值:vpc-5k6fot41
    CidrBlock String 辅助CIDR。形如:172.16.0.0/16
    示例值:172.16.1.0/24
    AssistantType Integer 辅助CIDR类型(0:普通辅助CIDR,1:容器辅助CIDR),默认都是0。
    示例值:0
    SubnetSet Array of Subnet 辅助CIDR拆分的子网。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[]

    BackupPolicy

    时间备份策略详情

    被如下接口引用:CreateSnapshotPolicies, DescribeSnapshotPolicies, ModifySnapshotPolicies。

    名称 类型 必选 描述
    BackupDay String 备份周期时间,取值为monday, tuesday, wednesday, thursday, friday, saturday, sunday。
    示例值:monday
    BackupTime String 备份时间点,格式:HH:mm:ss。
    示例值:3:00

    BandwidthPackage

    描述带宽包信息的结构

    被如下接口引用:DescribeBandwidthPackages。

    名称 类型 描述
    BandwidthPackageId String 带宽包唯一标识Id
    示例值:bwp-xxxxxx
    NetworkType String 带宽包类型,包括'BGP','SINGLEISP','ANYCAST','SINGLEISP_CMCC','SINGLEISP_CTCC','SINGLEISP_CUCC'
    示例值:BGP
    ChargeType String 带宽包计费类型,包括:
  • 'TOP5_POSTPAID_BY_MONTH':按月后付费TOP5计费
  • 'PERCENT95_POSTPAID_BY_MONTH':按月后付费月95计费
  • 'ENHANCED95_POSTPAID_BY_MONTH':按月后付费增强型95计费
  • 'FIXED_PREPAID_BY_MONTH':包月预付费计费
  • ‘PEAK_BANDWIDTH_POSTPAID_BY_DAY’: 后付费日结按带宽计费


  • 示例值:TOP5_POSTPAID_BY_MONTH
    BandwidthPackageName String 带宽包名称
    示例值:未命名
    CreatedTime Timestamp ISO8601 带宽包创建时间。按照ISO8601标准表示,并且使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ
    示例值:2021-04-27T09:06:07Z
    Status String 带宽包状态,包括'CREATING','CREATED','DELETING','DELETED'
    示例值:CREATED
    ResourceSet Array of Resource 带宽包资源信息
    Bandwidth Integer 带宽包限速大小。单位:Mbps,-1表示不限速。
    示例值:10
    Egress String 网络出口
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:center_egress1
    Deadline Timestamp ISO8601 带宽包到期时间,只有预付费会返回,按量计费返回为null
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2023-02-06T06:42:20Z

    BandwidthPackageBillBandwidth

    后付费共享带宽包的当前计费用量

    被如下接口引用:DescribeBandwidthPackageBillUsage。

    名称 类型 描述
    BandwidthUsage Float 当前计费用量,单位为 Mbps
    示例值:15

    BandwidthRange

    带宽上下限。

    被如下接口引用:DescribeAddressBandwidthRange, DescribeBandwidthPackageBandwidthRange。

    名称 类型 描述
    ResourceId String 资源ID。
    示例值:eip-1234test
    BandwidthLowerLimit Integer 带宽下限,单位:Mbps。
    示例值:1
    BandwidthUpperLimit Integer 带宽上限,单位:Mbps。
    示例值:200

    BatchModifySnapshotPolicy

    批量修改快照策略信息

    被如下接口引用:ModifySnapshotPolicies。

    名称 类型 必选 描述
    SnapshotPolicyId String 快照策略Id。
    示例值:sspolicy-5k6fot41
    SnapshotPolicyName String 快照策略名称。
    示例值:demo
    BackupPolicies Array of BackupPolicy 备份策略。
    示例值:[{"SnapshotPolicyId": "sspolicy-5k6fot41", "SnapshotPolicyName": "demo"}]
    KeepTime Integer 快照保留时间,支持1~365天。
    示例值:12

    BgpConfig

    BgpConfig

    被如下接口引用:CreateVpnConnection。

    名称 类型 必选 描述
    TunnelCidr String BGP隧道网段。
    示例值:169.254.128.0/30
    LocalBgpIp String 云端BGP地址。必须从BGP隧道网段内分配。
    示例值:169.254.128.1
    RemoteBgpIp String 用户端BGP地址。必须从BGP隧道网段内分配。
    示例值:169.254.128.2

    BgpConfigAndAsn

    VPN通道BGP配置

    被如下接口引用:CreateVpnConnection, DescribeVpnConnections。

    名称 类型 描述
    TunnelCidr String BGP通道CIDR
    示例值:169.254.128.0/30
    LocalBgpIp String 本端BGP IP
    示例值:169.254.128.1
    RemoteBgpIp String 对端BGP IP
    示例值:169.254.128.2
    LocalBgpAsn String 本端BGP ASN号
    示例值:31451
    RemoteBgpAsn String 对端BGP ASN号
    示例值:31451

    CCN

    云联网(CCN)对象

    被如下接口引用:CreateCcn, DescribeCcns。

    名称 类型 描述
    CcnId String 云联网唯一ID
    示例值:ccn-c21f68nb
    CcnName String 云联网名称
    示例值:ccn-01
    CcnDescription String 云联网描述信息
    示例值:ccn
    InstanceCount Integer 关联实例数量
    示例值:0
    CreateTime Timestamp 创建时间
    示例值:2021-09-15 11:41:35
    State String 实例状态, 'ISOLATED': 隔离中(欠费停服),'AVAILABLE':运行中。
    示例值:ISOLATED
    QosLevel String 实例服务质量,’PT’:白金,'AU':金,'AG':银。
    示例值:PT
    InstanceChargeType String 付费类型,PREPAID为预付费,POSTPAID为后付费。
    示例值:PREPAID
    BandwidthLimitType String 限速类型,INTER_REGION_LIMIT 为地域间限速;OUTER_REGION_LIMIT 为地域出口限速。
    示例值:INTER_REGION_LIMIT
    TagSet Array of Tag 标签键值对。
    示例值:[{'Key': 'key', 'Value': 'value'}]
    RoutePriorityFlag Boolean 是否支持云联网路由优先级的功能。False:不支持,True:支持。
    示例值:True
    RouteTableCount Integer 实例关联的路由表个数。
    示例值:0
    RouteTableFlag Boolean 是否开启云联网多路由表特性。False:未开启,True:开启。
    示例值:True
    IsSecurityLock Boolean true:实例已被封禁,流量不通,false:解封禁。
    示例值:False
    RouteBroadcastPolicyFlag Boolean 是否开启云联网路由传播策略。False 未开启,True 开启。
    示例值:True
    RouteECMPFlag Boolean 是否开启等价路由功能。False 未开启,True 开启。
    示例值:True
    RouteOverlapFlag Boolean 是否开启路由重叠功能。False 未开启,True 开启。
    示例值:True
    TrafficMarkingPolicyFlag Boolean 是否开启QOS。
    示例值:True
    RouteSelectPolicyFlag Boolean 是否开启路由表选择策略。
    示例值:True
    DirectConnectAccelerateChannelFlag Boolean 是否开启二层云联网通道。
    示例值:True
    Ipv6Flag Boolean 是否支持ipv6路由表
    示例值:True
    MrtbAggregatePolicyFlag Boolean 是否支持路由表聚合策略
    示例值:True
    MrtbPolicyValueFlag Boolean 是否支持策略值
    示例值:True

    CcnAttachedInstance

    云联网(CCN)关联实例(Instance)对象

    被如下接口引用:DescribeCcnAttachedInstances。

    名称 类型 描述
    CcnId String 云联网实例ID。
    示例值:ccn-31zf3vib
    InstanceType String 关联实例类型:
  • VPC:私有网络
  • DIRECTCONNECT:专线网关
  • BMVPC:黑石私有网络

  • 示例值:VPC
    InstanceId String 关联实例ID。
    示例值:vpc-lt6ork07
    InstanceName String 关联实例名称。
    示例值:ccn_instance_1
    InstanceRegion String 关联实例所属大区,例如:ap-guangzhou。
    示例值:ap-guangzhou
    InstanceUin String 关联实例所属UIN(根账号)。
    示例值:100000072292
    CidrBlock Array of String 关联实例CIDR。
    示例值:10.1.0.0/16
    State String 关联实例状态:
  • PENDING:申请中
  • ACTIVE:已连接
  • EXPIRED:已过期
  • REJECTED:已拒绝
  • DELETED:已删除
  • FAILED:失败的(2小时后将异步强制解关联)
  • ATTACHING:关联中
  • DETACHING:解关联中
  • DETACHFAILED:解关联失败(2小时后将异步强制解关联)

  • 示例值:ACTIVE
    AttachedTime Timestamp 关联时间。
    示例值:2021-03-03 16:19:44
    CcnUin String 云联网所属UIN(根账号)。
    示例值:100000072292
    InstanceArea String 关联实例所属的大地域,如: CHINA_MAINLAND
    示例值: CHINA_MAINLAND
    Description String 备注
    示例值:remark
    RouteTableId String 路由表ID
    示例值:ccnrtb-1234edfr
    RouteTableName String 路由表名称
    示例值:route_1

    CcnBandwidth

    用于描述云联网地域间限速带宽实例的信息。

    被如下接口引用:DescribeCrossBorderCcnRegionBandwidthLimits。

    名称 类型 描述
    CcnId String 带宽所属的云联网ID。
    示例值:ccn-k2c3b8ir
    CreatedTime String 实例的创建时间。
    示例值:2023-11-10 16:02:43
    ExpiredTime String 实例的过期时间
    示例值:2023-11-10 16:02:43
    RegionFlowControlId String 带宽实例的唯一ID。
    示例值:fcr-3jkeg2mc
    RenewFlag String 带宽是否自动续费的标记。
    示例值:NOTIFY_AND_AUTO_RENEW
    CcnRegionBandwidthLimit CcnRegionBandwidthLimitInfo 描述带宽的地域和限速上限信息。在地域间限速的情况下才会返回参数,出口限速模式不返回。
    示例值:{'SourceRegion': 'ap-hongkong', 'DestinationRegion': 'ap-beijing', 'BandwidthLimit': 100}
    MarketId String 云市场实例ID。
    示例值:market-32cu4uhcs
    UserAccountID String 实例所属用户主账号ID。
    示例值:2814325091
    IsCrossBorder Boolean 是否跨境,true表示跨境,反之不跨境。
    示例值:True
    IsSecurityLock Boolean true表示封禁,地域间流量不通,false解禁,地域间流量正常
    示例值:False
    InstanceChargeType String POSTPAID表示后付费,PREPAID表示预付费。
    示例值:POSTPAID
    UpdateTime String 实例更新时间
    示例值:2024-10-11 14:26:33

    CcnBandwidthInfo

    用于描述云联网地域间限速带宽实例的信息。

    被如下接口引用:GetCcnRegionBandwidthLimits。

    名称 类型 描述
    CcnId String 带宽所属的云联网ID。
    示例值:ccn-ef5nufih
    CreatedTime String 实例的创建时间。
    示例值:2018-12-18 20:11:37
    ExpiredTime String 实例的过期时间
    示例值:2019-01-18 20:11:37
    RegionFlowControlId String 带宽实例的唯一ID。
    示例值:fcr-6fda09za
    RenewFlag String 带宽是否自动续费的标记。
    示例值:NOTIFY_AND_AUTO_RENEW
    CcnRegionBandwidthLimit CcnRegionBandwidthLimit 描述带宽的地域和限速上限信息。在地域间限速的情况下才会返回参数,出口限速模式不返回。
    示例值:{'Region': 'ap-shanghai', 'IsBm': False, 'BandwidthLimit': 10000, 'DstRegion': 'ap-beijing', 'DstIsBm': False}
    MarketId String 云市场实例ID。
    示例值:market-3cef2rhkl
    TagSet Array of Tag 资源绑定的标签列表
    示例值:[{'Key': 'key', 'Value': 'value'}]
    DefaultQosBandwidthFlag Boolean true表示Qos默认带宽;false表示非Qos默认带宽;
    示例值:true
    QosLevel String 服务等级信息。
    示例值:AU

    CcnBatchRouteTable

    云联网路由表信息

    被如下接口引用:CreateCcnRouteTables。

    名称 类型 必选 描述
    CcnId String 云联网ID。
    示例值:ccn-245ecr35
    Name String 云联网路由表名称。
    示例值:local
    Description String 云联网路由表描述。
    示例值:deerers

    CcnFlowLock

    云联网限速实例锁对象,该对象特用于运营端使用,用于封禁实例流量。

    被如下接口引用:LockCcnBandwidths, UnlockCcnBandwidths。

    名称 类型 必选 描述
    CcnId String 带宽所属的云联网ID。
    示例值:ccn-2caehl6h
    UserAccountID String 实例所属用户主账号ID。
    示例值:201111300001
    RegionFlowControlId String 带宽实例的唯一ID。作为UnlockCcnBandwidths接口和LockCcnBandwidths接口的入参时,该字段必传。
    示例值:fcr-ceah9fdm

    CcnInstance

    云联网(CCN)关联实例(Instance)对象。

    被如下接口引用:AcceptAttachCcnInstances, AttachCcnInstances, DetachCcnInstances, ModifyCcnAttachedInstancesAttribute, RejectAttachCcnInstances, ResetAttachCcnInstances。

    名称 类型 必选 描述
    InstanceId String 关联实例ID。
    示例值:vpc-lt6ork07
    InstanceRegion String 关联实例ID所属大区,例如:ap-guangzhou。
    示例值:ap-guangzhou
    InstanceType String 关联实例类型,可选值:
  • VPC:私有网络
  • DIRECTCONNECT:专线网关
  • BMVPC:黑石私有网络
  • VPNGW:VPNGW类型

  • 示例值:VPC
    Description String 备注
    示例值:remark
    RouteTableId String 实例关联的路由表ID。
    示例值:ccnrtb-1234edfr
    OrderType String 实例付费方式
    示例值:PayByCcnOwner

    CcnInstanceInfo

    云联网实例对象,该对象特用于运营端使用,不建议给租户的接口中提供该复杂类型。

    被如下接口引用:DescribeTenantCcns。

    名称 类型 描述
    CcnId String 云联网唯一ID。
    示例值:ccn-3cef2rhkl

    CcnInstanceWithoutRegion

    ccn实例信息(不带地域属性)

    被如下接口引用:AssociateInstancesToCcnRouteTable。

    名称 类型 必选 描述
    InstanceType String 云联网支持的实例类型:
    VPC
    DIRECTCONNECT
    BMVPC
    EDGE
    EDGE_TUNNEL
    EDGE_VPNGW
    VPNGW
    示例值:VPC
    InstanceId String 实例ID。
    示例值:vpc-m0c2kcun

    CcnRegionBandwidthLimit

    云联网(CCN)地域出带宽上限

    被如下接口引用:DescribeCcnRegionBandwidthLimits, GetCcnRegionBandwidthLimits, SetCcnRegionBandwidthLimits。

    名称 类型 必选 描述
    Region String 地域,例如:ap-guangzhou
    示例值:ap-shanghai
    BandwidthLimit Integer 出带宽上限,单位:Mbps
    示例值:1000
    IsBm Boolean 是否黑石地域,默认false
    示例值:False
    DstRegion String 目的地域,例如:ap-shanghai
    示例值:ap-beijing
    DstIsBm Boolean 目的地域是否为黑石地域,默认false
    示例值:False

    CcnRegionBandwidthLimitInfo

    云联网(CCN)地域出带宽上限。

    被如下接口引用:DescribeCrossBorderCcnRegionBandwidthLimits。

    名称 类型 描述
    SourceRegion String 源地域,例如:ap-shanghai
    示例值:ap-shanghai
    DestinationRegion String 目的地域, 例如:ap-shanghai
    示例值:ap-guangzhou
    BandwidthLimit Integer 出带宽上限,单位:Mbps。
    示例值:1000

    CcnRoute

    CCN路由策略对象

    被如下接口引用:DescribeCcnRoutes。

    名称 类型 描述
    RouteId String 路由策略ID
    示例值:ccnr-hs2yc3ha
    DestinationCidrBlock String 目的端
    示例值:10.1.19.0/24
    InstanceType String 下一跳类型(关联实例类型),所有类型:VPC、DIRECTCONNECT
    示例值:VPC
    InstanceId String 下一跳(关联实例)
    示例值:vpc-fc21z82c
    InstanceName String 下一跳名称(关联实例名称)
    示例值:测试name
    InstanceRegion String 下一跳所属地域(关联实例所属地域)
    示例值:ap-guangzhou
    UpdateTime Timestamp 更新时间
    示例值:2022-11-19 15:20:25
    Enabled Boolean 路由是否启用
    示例值:True
    InstanceUin String 关联实例所属UIN(根账号)
    示例值:151241551
    ExtraState String 路由的扩展状态
    示例值:Running
    IsBgp Boolean 是否动态路由
    示例值:False
    RoutePriority Integer 路由优先级
    示例值:50
    InstanceExtraName String 下一跳扩展名称(关联实例的扩展名称)
    示例值:test-name
    AliasType String 实例类型
    示例值:VPC
    AliasInstanceId String 实例id
    示例值:alias-instance-id

    CcnRouteBroadcastPolicyRouteCondition

    云联网路由传播策略之路由条件

    被如下接口引用:DescribeCcnRouteTableBroadcastPolicys, DescribeCcnRouteTableInputPolicys, ReplaceCcnRouteTableBroadcastPolicys, ReplaceCcnRouteTableInputPolicys。

    名称 类型 必选 描述
    Name String 条件类型
    示例值:instance-type
    Values Array of String 条件值列表
    示例值:['VPC', 'DIRECTCONNECT']
    MatchPattern Integer 匹配模式,1 精确匹配,0 模糊匹配
    示例值:1

    CcnRouteTable

    云联网路由表信息

    被如下接口引用:CreateCcnRouteTables, DescribeCcnRouteTables。

    名称 类型 描述
    CcnId String 云联网ID。
    示例值:ccn-245ecr35
    CcnRouteTableId String 云联网路由表ID。
    示例值:ccnrtb-1234edfr
    RouteTableName String 云联网路由表名称。
    示例值:rtb-01
    RouteTableDescription String 云联网路由表描述。
    示例值:deerers
    IsDefaultTable Boolean True:是默认路由表 False:非默认路由表。
    示例值:True
    CreateTime Timestamp 创建时间。
    示例值:2021-05-14 11:16:45

    CcnRouteTableBroadcastPolicy

    云联网路由传播策略

    被如下接口引用:DescribeCcnRouteTableBroadcastPolicys, ReplaceCcnRouteTableBroadcastPolicys。

    名称 类型 必选 描述
    RouteConditions Array of CcnRouteBroadcastPolicyRouteCondition 路由条件
    示例值:{'Name': 'instance-id', 'Values': ['DIRECTCONNECT'], 'MatchPattern': 1}
    BroadcastConditions Array of CcnRouteBroadcastPolicyRouteCondition 传播条件
    示例值:{'Name': 'instance-id', 'Values': ['DIRECTCONNECT'], 'MatchPattern': 1}
    Action String 路由行为,accept 允许,drop 拒绝
    示例值:accept
    Description String 策略描述
    示例值:接收指定关联实例路由
    OperateAsPath String as-path操作
    示例值:63551/63552
    AsPathOperateMode String as-path操作模式
    示例值:prepend
    OperateCommunitySet Array of String community操作
    示例值:["65001:65001"]
    CommunityOperateMode String community操作模式
    示例值:add

    CcnRouteTableBroadcastPolicys

    云联网路由传播策略列表

    被如下接口引用:DescribeCcnRouteTableBroadcastPolicys。

    名称 类型 描述
    Policys Array of CcnRouteTableBroadcastPolicy 策略列表
    PolicyVersion Integer 版本号
    示例值:10
    CreateTime String 创建时间
    示例值:2022-05-24 19:28:31

    CcnRouteTableInputPolicy

    云联网路由接收策略

    被如下接口引用:DescribeCcnRouteTableInputPolicys, ReplaceCcnRouteTableInputPolicys。

    名称 类型 必选 描述
    RouteConditions Array of CcnRouteBroadcastPolicyRouteCondition 路由条件。
    示例值:[{"matchPattern": 0, "values": ["65001/65002"], "name": "asPath"}]
    Action String 路由行为,accept 允许,drop 拒绝。
    示例值:accept
    Description String 策略描述。
    示例值:接收指定关联实例路由
    OperateAsPath String as-path操作
    示例值:63551/63552
    AsPathOperateMode String as-path操作模式
    示例值:prepend

    CcnRouteTableInputPolicys

    云联网路由接收策略列表

    被如下接口引用:DescribeCcnRouteTableInputPolicys。

    名称 类型 描述
    Policys Array of CcnRouteTableInputPolicy 策略列表。
    示例值:[{'RouteConditions': [{'Name': 'instance-id', 'Values': ['vpc-1acu2375'], 'MatchPattern': 1}], 'Action': 'accept', 'Description': '接收指定关联实例路由'}]
    PolicyVersion Integer 版本号。
    示例值:10
    CreateTime String 创建时间。
    示例值:2022-05-24 19:28:31

    CcnRouteTableSelectPolicy

    路由表选择策略信息

    被如下接口引用:ModifyRouteTableSelectionPolicies。

    名称 类型 必选 描述
    InstanceType String 实例类型:
    私有网络: VPC
    专线网关: DIRECTCONNECT
    黑石私有网络: BMVPC
    EDGE设备: EDGE
    EDGE隧道: EDGE_TUNNEL
    EDGE网关: EDGE_VPNGW
    VPN网关:VPNGW
    示例值:VPC
    InstanceId String 实例ID。
    示例值:vpc-m0c2kcun
    SourceCidrBlock String 源端CIDR。
    示例值:10.0.0.0/16
    RouteTableId String 路由表ID。
    示例值:ccnrtb-1234edfr
    Description String 路由表备注。
    示例值:rtb-1

    CidrForCcn

    用于发布云联网的cidr信息

    被如下接口引用:CreateRouteTable, CreateRoutes, DescribeRouteTables。

    名称 类型 描述
    Cidr String local cidr值。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:10.0.0.0/16
    PublishedToVbc Boolean 是否发布到了云联网。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:True

    ClassicLinkInstance

    私有网络和基础网络互通设备

    被如下接口引用:DescribeClassicLinkInstances。

    名称 类型 描述
    VpcId String VPC实例ID
    示例值:vpc-nswq8wkq
    InstanceId String 云服务器实例唯一ID
    示例值:ins-kngiybxl

    ConflictItem

    冲突资源条目信息。

    被如下接口引用:CheckAssistantCidr。

    名称 类型 描述
    ConfilctId String 冲突资源的ID。已废弃
    示例值:rti-kngiybxl
    DestinationItem String 冲突目的资源
    示例值:10.0.0.0/24
    ConflictId String 冲突资源的ID
    示例值:rti-kngiybxl

    ConflictSource

    冲突资源信息。

    被如下接口引用:CheckAssistantCidr。

    名称 类型 描述
    ConflictSourceId String 冲突资源ID
    示例值:rtb-4t7fr3fi
    SourceItem String 冲突资源
    示例值:10.0.0.0/16
    ConflictItemSet Array of ConflictItem 冲突资源条目信息
    示例值:[{"ConflictId": "rti-4d8a10a1", "DestinationItem": "10.0.0.0/16"}]

    CreateVpnConnRoute

    创建路由添加的指向此通道的路由

    被如下接口引用:CreateVpnConnection。

    名称 类型 必选 描述
    DestinationCidrBlock String 目的端IDC网段
    示例值:11.0.0.0/16
    Priority Integer 优先级;可选值0,100。
    示例值:0

    CrossBorderCompliance

    合规化审批单

    被如下接口引用:DescribeCrossBorderCompliance。

    名称 类型 描述
    ServiceProvider String 服务商,可选值:UNICOM
    示例值:UNICOM
    ComplianceId Integer 合规化审批单ID
    示例值:13144
    Company String 公司全称。
    示例值:腾讯云产品测试公司
    UniformSocialCreditCode String 统一社会信用代码。
    示例值:451xxxxxxxxx365K
    LegalPerson String 法定代表人。
    示例值:张三
    IssuingAuthority String 发证机关。
    示例值:B机关
    BusinessLicense String 营业执照。
    示例值:https://xxxx.com/xxxx
    BusinessAddress String 营业执照住所。
    示例值:中国xxx省xxx市xxx
    PostCode Integer 邮编。
    示例值:0123013
    Manager String 经办人。
    示例值:张三
    ManagerId String 经办人身份证号。
    示例值:33077xxxxxxxxxxxx1
    ManagerIdCard String 经办人身份证。
    示例值:https://xxxx.com/xxxx
    ManagerAddress String 经办人身份证地址。
    示例值:中国xxx省xxx市xxx
    ManagerTelephone String 经办人联系电话。
    示例值:176xxxxxxx80
    Email String 电子邮箱。
    示例值:xxx@xxx.com
    ServiceHandlingForm String 服务受理单。
    示例值:https://xxxx.com/xxxx
    AuthorizationLetter String 授权函。
    示例值:https://xxxx.com/xxxx
    SafetyCommitment String 信息安全承诺书。
    示例值:https://xxxx.com/xxxx
    ServiceStartDate Date 服务开始时间。
    示例值:2020-10-01
    ServiceEndDate Date 服务截止时间。
    示例值:2023-09-30
    State String 状态。待审批:PENDING,已通过:APPROVED,已拒绝:DENY
    示例值:APPROVED
    CreatedTime Timestamp 审批单创建时间。
    示例值:2020-10-01 15:00:00
    LegalPersonId String 法定代表人身份证号。
    示例值:330xxxxxxxxxxxxxx1
    LegalPersonIdCard String 法定代表人身份证。
    示例值:https://xxxx.com/xxxx

    CrossBorderFlowMonitorData

    跨境带宽监控数据

    被如下接口引用:DescribeCrossBorderFlowMonitor。

    名称 类型 描述
    InBandwidth Array of Integer 入带宽,单位:bps
    示例值:[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
    OutBandwidth Array of Integer 出带宽,单位:bps
    示例值:[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
    InPkg Array of Integer 入包,单位:pps
    示例值:[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
    OutPkg Array of Integer 出包,单位:pps
    示例值:[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]

    CustomerGateway

    对端网关

    被如下接口引用:CreateCustomerGateway, DescribeCustomerGateways。

    名称 类型 描述
    CustomerGatewayId String 用户网关唯一ID
    示例值:cgw-021cr501
    CustomerGatewayName String 网关名称
    示例值:对端网关-1
    IpAddress String 公网地址
    示例值:12.31.451.4
    CreatedTime String 创建时间
    示例值:2024-11-15 10:33:22
    BgpAsn Integer BGP ASN。
    示例值:2731

    CustomerGatewayVendor

    对端网关厂商信息对象。

    被如下接口引用:DescribeCustomerGatewayVendors, DownloadCustomerGatewayConfiguration。

    名称 类型 必选 描述
    Platform String 平台。
    示例值:comware
    SoftwareVersion String 软件版本。
    示例值:V1.0
    VendorName String 供应商名称。
    示例值:h3c

    CvmInstance

    云主机实例信息。

    被如下接口引用:DescribeVpcInstances。

    名称 类型 描述
    VpcId String VPC实例ID。
    示例值:vpc-kngiybxl
    SubnetId String 子网实例ID。
    示例值:subnet-hj3he929
    InstanceId String 云主机实例ID
    示例值:ins-nswq8wkq
    InstanceName String 云主机名称。
    示例值:demo
    InstanceState String 云主机状态。
    示例值:RUNNING
    CPU Integer 实例的CPU核数,单位:核。
    示例值:8
    Memory Integer 实例内存容量,单位:GB。
    示例值:32
    CreatedTime String 创建时间。
    示例值:2020-06-08 10:00:00
    InstanceType String 实例机型。
    示例值:SA3.2XLARGE32
    EniLimit Integer 实例弹性网卡配额(包含主网卡)。
    示例值:6
    EniIpLimit Integer 实例弹性网卡内网IP配额(包含主网卡)。
    示例值:20
    InstanceEniCount Integer 实例已绑定弹性网卡的个数(包含主网卡)。
    示例值:1

    DefaultVpcSubnet

    默认VPC和子网

    被如下接口引用:CreateDefaultVpc。

    名称 类型 描述
    VpcId String 默认VpcId。
    示例值:vpc-6vbg797r
    SubnetId String 默认SubnetId。
    示例值:subnet-3opmksyg
    VpcName String 默认Vpc名字。
    示例值:Default-VPC
    SubnetName String 默认Subnet名字。
    示例值:Default-Subnet
    CidrBlock String 默认子网网段。
    示例值:172.16.0.0/16

    DestinationIpPortTranslationNatRule

    NAT网关的端口转发规则

    被如下接口引用:CreateNatGateway, CreateNatGatewayDestinationIpPortTranslationNatRule, DeleteNatGatewayDestinationIpPortTranslationNatRule, DescribeNatGateways, ModifyNatGatewayDestinationIpPortTranslationNatRule。

    名称 类型 必选 描述
    IpProtocol String 网络协议,可选值:TCPUDP
    示例值:TCP
    PublicIpAddress String 弹性IP。
    示例值:114.182.81.73
    PublicPort Integer 公网端口。
    示例值:80
    PrivateIpAddress String 内网地址。
    示例值:192.168.4.43
    PrivatePort Integer 内网端口。
    示例值:80
    Description String NAT网关转发规则描述。
    示例值:webservice

    DestinationIpPortTranslationNatRuleDiff

    本端目的IP端口转换复杂结构

    被如下接口引用:ModifyPrivateNatGatewayDestinationIpPortTranslationNatRule。

    名称 类型 必选 描述
    Protocol String 协议
    示例值:"TCP"
    OriginalPort Integer 源端口
    示例值:80
    OriginalIp String 源IP
    示例值:"10.0.13.19"
    TranslationPort Integer 目的端口
    示例值:8081
    TranslationIp String 目的IP
    示例值:"10.0.13.1"
    OldProtocol String 旧协议。
    示例值:"UDP"
    OldOriginalPort Integer 旧源端口
    示例值:80
    OldOriginalIp String 旧源IP
    示例值:"10.0.13.19"
    OldTranslationPort Integer 旧目的端口
    示例值:8081
    OldTranslationIp String 旧目的IP
    示例值:"10.0.13.1"
    Description String 描述
    示例值:webservice

    DhcpIp

    描述 DhcpIp 信息

    被如下接口引用:CreateDhcpIp, DescribeDhcpIps。

    名称 类型 描述
    DhcpIpId String DhcpIpID,是DhcpIp的唯一标识。
    示例值:dhcpip-kelim00k
    VpcId String DhcpIp所在私有网络ID
    示例值:vpc-5k6fot41
    SubnetId String DhcpIp所在子网ID
    示例值:subnet-kgpu7qt2
    DhcpIpName String DhcpIp的名称。
    示例值:demo
    PrivateIpAddress String IP地址。
    示例值:192.168.0.10
    AddressIp String 绑定EIP
    示例值:123.100.10.171
    NetworkInterfaceId String DhcpIp关联弹性网卡ID
    示例值:eni-8g66q1hr
    InstanceId String 被绑定的实例ID
    示例值:ins-md35dfai
    State String 状态:
  • AVAILABLE:运行中
  • UNBIND:未绑定

  • 示例值:AVAILABLE
    CreatedTime Timestamp 创建时间。
    示例值: 2020-06-02 16:28:38
    TagSet Array of Tag 标签键值对。
    示例值:[{"Key": "env", "Value": "prod"}]

    DirectConnectGateway

    专线网关对象。

    被如下接口引用:CreateDirectConnectGateway, DescribeDirectConnectGateways。

    名称 类型 描述
    DirectConnectGatewayId String 专线网关ID
    示例值:dcg-e6mxyyvj
    DirectConnectGatewayName String 专线网关名称。
    示例值:我的网关01
    VpcId String 专线网关关联VPC实例ID
    示例值:vpc-hm2okght
    NetworkType String 关联网络类型:
  • VPC - 私有网络
  • CCN - 云联网

  • 示例值:CCN
    NetworkInstanceId String 关联网络实例ID
  • NetworkTypeVPC时,这里为私有网络实例ID
  • NetworkTypeCCN时,这里为云联网实例ID

  • 示例值:ccn-4rukgymd
    GatewayType String 网关类型:
  • NORMAL - 标准型,注:云联网只支持标准型
  • NAT - NAT型

  • NAT类型支持网络地址转换配置,类型确定后不能修改;一个私有网络可以创建一个NAT类型的专线网关和一个非NAT类型的专线网关
    示例值:NORMAL
    CreateTime Timestamp 创建时间。
    示例值:2020-02-01 12:00:00
    DirectConnectGatewayIp String 专线网关IP。
    示例值:10.212.253.59
    CcnId String 专线网关关联CCN实例ID
    示例值:ccn-4rukgymd
    CcnRouteType String 云联网路由学习类型:
  • BGP - 自动学习。
  • STATIC - 静态,即用户配置。

  • 示例值:BGP
    EnableBGP Boolean 是否启用BGP。
    示例值:true
    EnableBGPCommunity Boolean 开启和关闭BGP的community属性。
    示例值:false
    NatGatewayId String 绑定的NAT网关ID。
    示例值:NAT-TEST
    VXLANSupport Array of Boolean 专线网关是否支持VXLAN架构
    示例值:true
    ModeType String 云联网路由发布模式:standard(标准模式)、exquisite(精细模式)。
    示例值:standard
    LocalZone Boolean 是否为localZone专线网关。
    示例值:false
    Zone String 专线网关所在可用区
    示例值:ap-guangzhou-1
    EnableFlowDetails Integer 网关流控明细启用状态:
    0:关闭
    1:开启
    示例值:0
    FlowDetailsUpdateTime String 开启、关闭网关流控明细时间
    示例值:2020-02-01 12:00:00
    NewAfc Integer 是否支持开启网关流控明细
    0:不支持
    1:支持
    示例值:1
    AccessNetworkType String 专线网关接入网络类型:
  • VXLAN - VXLAN类型。
  • MPLS - MPLS类型。
  • Hybrid - Hybrid类型。

  • 示例值:VXLAN
    HaZoneList Array of String 跨可用区容灾专线网关的可用区列表
    示例值:["ap-guangzhou-1"]
    GatewayAsn Integer 专线网关自定义ASN
    示例值:45090

    DirectConnectGatewayCcnRoute

    专线网关云联网路由(IDC网段)对象

    被如下接口引用:CreateDirectConnectGatewayCcnRoutes, DescribeDirectConnectGatewayCcnRoutes, ReplaceDirectConnectGatewayCcnRoutes。

    名称 类型 必选 描述
    RouteId String 路由ID。
    示例值:dcr-xxxxxxx
    DestinationCidrBlock String IDC网段。
    示例值:192.168.1.0/24
    ASPath Array of String BGPAS-Path属性。
    示例值:['2342', '342']
    Description String 备注
    示例值:备注
    UpdateTime String 最后更新时间
    示例值:2021-01-01 00:00:00

    DirectConnectSubnet

    IDC子网信息

    被如下接口引用:RefreshDirectConnectGatewayRouteToNatGateway。

    名称 类型 描述
    DirectConnectGatewayId String 专线网关ID
    示例值:dcg-71awizmv
    CidrBlock String IDC子网网段
    示例值:99.99.99.77/32

    EndPoint

    终端节点详情。

    被如下接口引用:CreateVpcEndPoint, CreateVpcEndPointService, DescribeVpcEndPoint, DescribeVpcEndPointService。

    名称 类型 描述
    EndPointId String 终端节点ID。
    示例值:vpce-pnpcflil
    VpcId String VPCID。
    示例值:vpc-hj3he929
    SubnetId String 子网ID。
    示例值:subnet-4t7fr3fi
    EndPointOwner String APPID。
    示例值:1302384414
    EndPointName String 终端节点名称。
    示例值:demo
    ServiceVpcId String 终端节点服务的VPCID。
    示例值:vpc-hj3he929
    ServiceVip String 终端节点服务的VIP。
    示例值:10.0.0.10
    EndPointServiceId String 终端节点服务的ID。
    示例值:vpcsvc-tyhgrwet
    EndPointVip String 终端节点的VIP。
    示例值:10.0.0.8
    State String 终端节点状态,ACTIVE:可用,PENDING:待接受,ACCEPTING:接受中,REJECTED:已拒绝,FAILED:失败。
    示例值:PENDING
    CreateTime String 创建时间。
    示例值:2018-04-03 15:00:00
    GroupSet Array of String 终端节点绑定的安全组实例ID列表。
    示例值:["sg-nswq8wkq"]
    ServiceName String 终端节点服务名称。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:demo
    CdcId String CDC 集群唯一 ID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:cluster-d8htgb6k
    TagSet Array of Tag 标签键值对。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[{"Key": "tag-key", "Value": "tag-value"}]

    EndPointService

    终端节点服务对象。

    被如下接口引用:CreateVpcEndPointService, DescribeVpcEndPointService。

    名称 类型 描述
    EndPointServiceId String 终端节点服务ID
    示例值:vpcsvc-pnpcflil
    VpcId String VPCID。
    示例值:vpc-hj3he929
    ServiceOwner String APPID。
    示例值:251007979
    ServiceName String 终端节点服务名称。
    示例值:demo
    ServiceVip String 后端服务的VIP。
    示例值:10.1.1.1
    ServiceInstanceId String 后端服务的ID,比如lb-xxx。
    示例值:lb-nswq8wkq
    AutoAcceptFlag Boolean 是否自动接受。
    示例值:True
    EndPointCount Integer 关联的终端节点个数。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    EndPointSet Array of EndPoint 终端节点对象数组。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[]
    CreateTime String 创建时间。
    示例值:2018-04-03 15:00:00
    ServiceType String 挂载的PAAS服务类型,CLB,CDB,CRS
    示例值:CLB,CDB,CRS
    CdcId String CDC 集群唯一 ID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:cluster-d8htgb6k
    ServiceUin String Uin
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:251007979123
    BusinessIpType Integer 服务IP类型
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:26
    TagSet Array of Tag 标签键值对。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[]

    Filter

    过滤器

    被如下接口引用:DescribeAddressTemplateGroups, DescribeAddressTemplates, DescribeAddresses, DescribeAssistantCidr, DescribeBandwidthPackageResources, DescribeBandwidthPackages, DescribeCcnAttachedInstances, DescribeCcnRouteTables, DescribeCcnRoutes, DescribeCcns, DescribeCrossBorderCcnRegionBandwidthLimits, DescribeCustomerGateways, DescribeDhcpIps, DescribeDirectConnectGateways, DescribeFlowLogs, DescribeHaVips, DescribeHighPriorityRouteTables, DescribeHighPriorityRoutes, DescribeIPv6Addresses, DescribeIp6Addresses, DescribeIp6Translators, DescribeLocalGateway, DescribeNatGatewayDestinationIpPortTranslationNatRules, DescribeNatGatewaySourceIpTranslationNatRules, DescribeNatGateways, DescribeNetDetectStates, DescribeNetDetects, DescribeNetworkAclQuintupleEntries, DescribeNetworkAcls, DescribeNetworkInterfaces, DescribePrivateNatGatewayDestinationIpPortTranslationNatRules, DescribePrivateNatGatewayLimits, DescribePrivateNatGatewayTranslationNatRules, DescribePrivateNatGateways, DescribeReserveIpAddresses, DescribeRouteList, DescribeRouteTableAssociatedInstances, DescribeRouteTableSelectionPolicies, DescribeRouteTables, DescribeRoutes, DescribeSecurityGroupPolicies, DescribeSecurityGroups, DescribeServiceTemplateGroups, DescribeServiceTemplates, DescribeSnapshotAttachedInstances, DescribeSnapshotPolicies, DescribeSpecificTrafficPackageUsedDetails, DescribeSubnets, DescribeTenantCcns, DescribeTrafficMirrors, DescribeTrafficPackages, DescribeUsedIpAddress, DescribeVpcEndPoint, DescribeVpcEndPointService, DescribeVpcEndPointServiceWhiteList, DescribeVpcInstances, DescribeVpcPeeringConnections, DescribeVpcs, DescribeVpnConnections, DescribeVpnGatewayRoutes, DescribeVpnGatewaySslClients, GetCcnRegionBandwidthLimits。

    名称 类型 必选 描述
    Name String 属性名称, 若存在多个Filter时,Filter间的关系为逻辑与(AND)关系。
    示例值:tag-key
    Values Array of String 属性值, 若同一个Filter存在多个Values,同一Filter下Values间的关系为逻辑或(OR)关系。当值类型为布尔类型时,可直接取值为字符串"TRUE"或 "FALSE"。
    示例值:["TagKeyA", "TagKeyB"]

    FilterObject

    过滤器键值对

    被如下接口引用:DescribeClassicLinkInstances, DescribeVpnGatewaySslServers, DescribeVpnGateways。

    名称 类型 必选 描述
    Name String 属性名称, 若存在多个Filter时,Filter间的关系为逻辑与(AND)关系。
    示例值:vpc-id
    Values Array of String 属性值, 若同一个Filter存在多个Values,同一Filter下Values间的关系为逻辑或(OR)关系。
    示例值:["vpc-pnpcflil"]

    FlowLog

    流日志

    被如下接口引用:CreateFlowLog, DescribeFlowLog, DescribeFlowLogs。

    名称 类型 描述
    VpcId String 私用网络ID或者统一ID,建议使用统一ID。
    示例值:vpc-pq9vxykj
    FlowLogId String 流日志唯一ID。
    示例值:fl-f42uhpkj
    FlowLogName String 流日志实例名字。
    示例值:test-flowlog
    ResourceType String 流日志所属资源类型,VPC|SUBNET|NETWORKINTERFACE|CCN|NAT|DCG。
    示例值:NETWORKINTERFACE
    ResourceId String 资源唯一ID。
    示例值:eni-78ysaex1
    TrafficType String 流日志采集类型,ACCEPT|REJECT|ALL。
    示例值:ACCEPT
    CloudLogId String 流日志存储ID。
    示例值:99991111-2222-4444-9999-222266663333
    CloudLogState String 流日志存储ID状态。
    示例值:SUCCESS
    FlowLogDescription String 流日志描述信息。
    示例值:demo
    CreatedTime String 流日志创建时间。
    示例值:2020-01-30 00:00:00
    TagSet Array of Tag 标签列表,例如:[{"Key": "city", "Value": "shanghai"}]。
    示例值:[]
    Enable Boolean 是否启用,true-启用,false-停用。
    示例值:true
    StorageType String 消费端类型:cls、ckafka。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:cls
    FlowLogStorage FlowLogStorage 消费端信息,当消费端类型为ckafka时返回。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[]
    CloudLogRegion String 流日志存储ID对应的地域信息。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:ap-guangzhou

    FlowLogStorage

    流日志存储信息

    被如下接口引用:CreateFlowLog, DescribeFlowLog, DescribeFlowLogs。

    名称 类型 必选 描述
    StorageId String 存储实例Id,当流日志存储类型为ckafka时,必填。
    示例值:ckafka-aso1kaoq
    StorageTopic String 主题Id,当流日志存储类型为ckafka时,必填。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:topic-asow02oa

    GatewayFlowMonitorDetail

    网关流量监控明细

    被如下接口引用:DescribeGatewayFlowMonitorDetail。

    名称 类型 描述
    PrivateIpAddress String 来源IP
    示例值:192.168.1.21
    InPkg Integer 入包量。
    示例值:1400
    OutPkg Integer 出包量。
    示例值:1527
    InTraffic Integer 入流量,单位:Byte
    示例值:32876
    OutTraffic Integer 出流量,单位:Byte
    示例值:65428
    ConcurrentConnectionCount Integer 并发连接数。仅标准型nat支持此参数。
    示例值:1000
    NewConnectionRate Integer 新建连接速率。仅标准型nat支持此参数。
    示例值:100

    GatewayQos

    网关流控带宽信息

    被如下接口引用:DescribeGatewayFlowQos。

    名称 类型 描述
    VpcId String VPC实例ID。
    示例值:vpc-adn18azc
    IpAddress String 云服务器内网IP。
    示例值:192.168.3.23
    Bandwidth Integer 流控带宽值。
    示例值:50
    CreateTime String 创建时间。
    示例值:2023-12-25 12:30:00

    HaVip

    描述 HAVIP 信息

    被如下接口引用:CreateHaVip, DescribeHaVips。

    名称 类型 描述
    HaVipId String HAVIPID,是HAVIP的唯一标识。
    示例值:havip-nswq8wkq
    HaVipName String HAVIP名称。
    示例值:demo
    Vip String 虚拟IP地址。
    示例值:10.0.0.10
    VpcId String HAVIP所在私有网络ID
    示例值:vpc-hj3he929
    SubnetId String HAVIP所在子网ID
    示例值:subnet-4t7fr3fi
    NetworkInterfaceId String HAVIP关联弹性网卡ID
    示例值:eni-pnpcflil
    InstanceId String 被绑定的实例ID
    示例值:ins-kngiybxl
    AddressIp String 绑定EIP
    示例值:100.10.123.131
    State String 状态:
  • AVAILABLE:运行中
  • UNBIND:未绑定

  • 示例值:AVAILABLE
    CreatedTime Timestamp 创建时间。
    示例值:2018-10-10 17:03:09
    Business String 使用havip的业务标识。
    示例值:SCF
    HaVipAssociationSet Array of HaVipAssociation HAVIP的飘移范围。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[{"HaVipId": "havip-nswq8wkq", "InstanceId": "ins-kngiybxl", "InstanceType": "CVM"}]
    CheckAssociate Boolean 是否开启HAVIP的飘移范围校验。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:True
    CdcId String CDC实例ID。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:cluster-gbo27yc4
    FlushedTime String HAVIP 刷新时间。该参数只作为出参数。以下场景会触发 FlushTime 被刷新:1)子机发出免费 ARP 触发 HAVIP 漂移;2)手动HAVIP解绑网卡; 没有更新时默认值:0000-00-00 00:00:00
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2024-06-06 22:24:45
    TagSet Array of Tag 标签键值对。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[]

    HaVipAssociation

    HaVip绑定的子机/网卡(用于限制HaVip飘移的范围,并不是真正的飘移动作)。

    被如下接口引用:CreateHaVip, DescribeHaVips。

    名称 类型 必选 描述
    InstanceId String HaVip绑定的子机或网卡唯一ID。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:ins-3qx9elib
    HaVipId String HaVip实例唯一ID。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:havip-7tqt5jn6
    InstanceType String HaVip绑定的类型。取值:CVM, ENI。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:CVM

    HealthCheckConfig

    VPN通道健康检查配置

    被如下接口引用:CreateVpnConnection, DescribeVpnConnections, ModifyVpnConnectionAttribute。

    名称 类型 必选 描述
    ProbeType String 探测模式,默认值NQA,不可修改。
    示例值:NQA
    ProbeInterval Integer 探测间隔,腾讯云两次健康检查间隔时间,范围【1000-5000】,单位ms。
    示例值:5000
    ProbeThreshold Integer 探测次数,连续N次健康检查失败后执行路由切换,范围【3-8】,单位次。
    示例值:3
    ProbeTimeout Integer 探测超时时间,范围【10-5000】,单位ms。
    示例值:150

    HighPriorityModifyItem

    高优路由表条目修改属性。

    被如下接口引用:ModifyHighPriorityRouteAttribute。

    名称 类型 必选 描述
    HighPriorityRouteId String 高优路由条目唯一ID。
    示例值:hprtb-kngiybxl
    Description String 高优路由条目描述。
    示例值:demo

    HighPriorityRoute

    高优路由表条目信息

    被如下接口引用:CreateHighPriorityRouteTable, CreateHighPriorityRoutes, DeleteHighPriorityRoutes, DescribeHighPriorityRouteTables, DescribeHighPriorityRoutes, ReplaceHighPriorityRoutes, ResetHighPriorityRoutes。

    名称 类型 必选 描述
    HighPriorityRouteTableId String 高优路由表唯一 ID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:hprtb-18mot1fm
    HighPriorityRouteId String 高优路由表条目唯一 ID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:hprti-p1ymd0ak
    DestinationCidrBlock String 目标网段
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:172.20.0.0/16
    GatewayType String 网关类型
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:HAVIP
    GatewayId String 网关唯一ID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:havip-mt4yhdps
    Description String 高优路由条目描述
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:test_high_priority_item
    SubnetRouteAlgorithm String ECMP算法,支持的算法有:ECMP_QUINTUPLE_HASH:五元组hash,ECMP_SOURCE_DESTINATION_IP_HASH:源和目的IP hash,ECMP_DESTINATION_IP_HASH:目的IP hash,ECMP_SOURCE_IP_HASH:源IP hash。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:ECMP_QUINTUPLE_HASH
    IsCdc Boolean 出参展示,是否为CDC属性高优路由
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:true
    CdcId String 出参展示,CDC 唯一ID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:cdc-hj3he929
    CreatedTime String 创建时间。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2021-03-02 14:41:15

    HighPriorityRouteTable

    高优路由表信息

    被如下接口引用:CreateHighPriorityRouteTable, DescribeHighPriorityRouteTables。

    名称 类型 描述
    HighPriorityRouteTableId String 高优路由表唯一 ID。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:hprtb-18mot1fm
    VpcId String VPC实例ID。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:vpc-m0c2kcun
    Name String 高优路由表名称。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:demo
    SubnetSet Array of String 高优路由表关联的子网列表。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:["subnet-ie8choou"]
    HighPriorityRouteSet Array of HighPriorityRoute 高优路由表条目信息
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[]
    CreatedTime String 创建时间。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2021-03-02 14:41:15

    IKEOptionsSpecification

    IKE配置(Internet Key Exchange,因特网密钥交换),IKE具有一套自我保护机制,用户配置网络安全协议

    被如下接口引用:CreateVpnConnection, DescribeVpnConnections, ModifyVpnConnectionAttribute。

    名称 类型 必选 描述
    PropoEncryAlgorithm String 加密算法,可选值:'3DES-CBC', 'AES-CBC-128', 'AES-CBS-192', 'AES-CBC-256', 'DES-CBC','SM4', 默认为3DES-CBC
    示例值:3DES-CBC
    PropoAuthenAlgorithm String 认证算法:可选值:'MD5', 'SHA1','SHA-256' 默认为MD5
    示例值:MD5
    ExchangeMode String 协商模式:可选值:'AGGRESSIVE', 'MAIN',默认为MAIN
    示例值:MAIN
    LocalIdentity String 本端标识类型:可选值:'ADDRESS', 'FQDN',默认为ADDRESS
    示例值:ADDRESS
    RemoteIdentity String 对端标识类型:可选值:'ADDRESS', 'FQDN',默认为ADDRESS
    示例值:ADDRESS
    LocalAddress String 本端标识,当LocalIdentity选为ADDRESS时,LocalAddress必填。localAddress默认为vpn网关公网IP
    示例值:1.2.3.4
    RemoteAddress String 对端标识,当RemoteIdentity选为ADDRESS时,RemoteAddress必填
    示例值:4.3.2.1
    LocalFqdnName String 本端标识,当LocalIdentity选为FQDN时,LocalFqdnName必填
    示例值:LocalName
    RemoteFqdnName String 对端标识,当remoteIdentity选为FQDN时,RemoteFqdnName必填
    示例值:RemoteName
    DhGroupName String DH group,指定IKE交换密钥时使用的DH组,可选值:'GROUP1', 'GROUP2', 'GROUP5', 'GROUP14', 'GROUP24',
    示例值:GOURP1
    IKESaLifetimeSeconds Integer IKE SA Lifetime,单位:秒,设置IKE SA的生存周期,取值范围:60-604800
    示例值:60
    IKEVersion String IKE版本
    示例值:1

    IPSECOptionsSpecification

    IPSec配置,腾讯云提供IPSec安全会话设置

    被如下接口引用:CreateVpnConnection, DescribeVpnConnections, ModifyVpnConnectionAttribute。

    名称 类型 必选 描述
    EncryptAlgorithm String 加密算法,可选值:'3DES-CBC', 'AES-CBC-128', 'AES-CBC-192', 'AES-CBC-256', 'DES-CBC', 'SM4', 'NULL', 默认为AES-CBC-128
    示例值:AES-CBC-128
    IPSECSaLifetimeSeconds Integer IPsec SA lifetime(s):单位秒,取值范围:180-604800
    示例值:180
    PfsDhGroup String PFS:可选值:'NULL', 'DH-GROUP1', 'DH-GROUP2', 'DH-GROUP5', 'DH-GROUP14', 'DH-GROUP24',默认为NULL
    示例值:NULL
    IPSECSaLifetimeTraffic Integer IPsec SA lifetime(KB):单位KB,取值范围:2560-604800
    示例值:2560
    IntegrityAlgorithm String 认证算法:可选值:'MD5', 'SHA1','SHA-256' 默认为
    示例值:SHA1

    InstanceBind

    云联网实例绑定路由表信息

    被如下接口引用:DescribeRouteTableAssociatedInstances。

    名称 类型 描述
    CcnId String 云联网ID。
    示例值:ccn-245ecr35
    InstanceType String 实例类型:VPC,DIRECTCONNECT,BMVPC,EDGE,EDGE_TUNNEL,EDGE_VPNGW,VPNGW。
    示例值:VPC
    InstanceId String 实例ID。
    示例值:vpc-m0c2kcun
    InstanceBindTime Timestamp 实例绑定路由表的时间。
    示例值:2021-05-20 16:39:34
    RouteTableId String 路由表ID。
    示例值:ccnrtb-1234edfr
    InstanceName String 实例名称。
    示例值:tesetsa
    InstanceRegion String 实例所在地域。
    示例值:ap-guangzhou
    InstanceUin String 实例所属的账户uin。
    示例值:329087131
    State String 关联实例状态:
  • PENDING:申请中
  • ACTIVE:已连接
  • EXPIRED:已过期
  • REJECTED:已拒绝
  • DELETED:已删除
  • FAILED:失败的(2小时后将异步强制解关联)
  • ATTACHING:关联中
  • DETACHING:解关联中
  • DETACHFAILED:解关联失败(2小时后将异步强制解关联)

  • 示例值:ACTIVE

    InstanceChargePrepaid

    预付费(包年包月)计费对象。

    被如下接口引用:CreateVpnGateway, InquiryPriceCreateVpnGateway, InquiryPriceRenewVpnGateway, RenewVpnGateway。

    名称 类型 必选 描述
    Period Integer 购买实例的时长,单位:月。取值范围:1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36。
    示例值:1
    RenewFlag String 自动续费标识。取值范围: NOTIFY_AND_AUTO_RENEW:通知过期且自动续费, NOTIFY_AND_MANUAL_RENEW:通知过期不自动续费。默认:NOTIFY_AND_AUTO_RENEW
    示例值:NOTIFY_AND_AUTO_RENEW

    InstanceStatistic

    用于描述实例的统计信息

    被如下接口引用:DescribeSecurityGroupAssociationStatistics。

    名称 类型 描述
    InstanceType String 实例的类型
    示例值:CVM
    InstanceCount Integer 实例的个数
    示例值:10

    InternetPrice

    公网询价出参

    被如下接口引用:InquiryPriceAllocateAddresses, InquiryPriceModifyAddressesBandwidth, InquiryPriceRenewAddresses。

    名称 类型 描述
    AddressPrice InternetPriceDetail 公网IP询价详细参数。

    InternetPriceDetail

    公网IP询价出参

    被如下接口引用:InquiryPriceAllocateAddresses, InquiryPriceModifyAddressesBandwidth, InquiryPriceRenewAddresses。

    名称 类型 描述
    UnitPrice Float 付费单价,单位:元,仅后付费价格查询返回。
    示例值:80
    DiscountPrice Float 折扣后的价格,单位:元。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:80
    ChargeUnit String 计价单元,可取值范围:
    • HOUR:表示计价单元是按每小时来计算。当前涉及该计价单元的场景有:流量按小时后付费(TRAFFIC_POSTPAID_BY_HOUR)、带宽按小时后付费(BANDWIDTH_POSTPAID_BY_HOUR)。

    注意:此字段可能返回 null,表示取不到有效值。
    示例值:HOUR
    OriginalPrice Float 原价,单位:元,仅预付费价格查询返回。
    示例值:80

    Ip6Rule

    IPV6转换规则

    被如下接口引用:DescribeIp6Translators。

    名称 类型 描述
    Ip6RuleId String IPV6转换规则唯一ID,形如rule6-xxxxxxxx
    示例值:rule6-ganlwp48
    Ip6RuleName String IPV6转换规则名称
    示例值:demo
    Vip6 String IPV6地址
    示例值:2402:4e00:40:40::2:2a6
    Vport6 Integer IPV6端口号
    示例值:80
    Protocol String 协议类型,支持TCP/UDP
    示例值:TCP
    Vip String IPV4地址
    示例值:10.0.0.0
    Vport Integer IPV4端口号
    示例值:80
    RuleStatus String 转换规则状态,限于CREATING,RUNNING,DELETING,MODIFYING
    示例值:RUNNING
    CreatedTime Timestamp ISO8601 转换规则创建时间
    示例值:2023-07-26T02:27:16Z

    Ip6RuleInfo

    IPV6转换规则

    被如下接口引用:AddIp6Rules。

    名称 类型 必选 描述
    Vport6 Integer IPV6端口号,可在0~65535范围取值
    示例值:80
    Protocol String 协议类型,支持TCP/UDP
    示例值:TCP
    Vip String IPV4地址
    示例值:172.0.0.0
    Vport Integer IPV4端口号,可在0~65535范围取值
    示例值:80

    Ip6Translator

    IPV6转换实例信息

    被如下接口引用:DescribeIp6Translators。

    名称 类型 描述
    Ip6TranslatorId String IPV6转换实例唯一ID,形如ip6-xxxxxxxx
    示例值:ip6-mhnrv51i
    Ip6TranslatorName String IPV6转换实例名称
    示例值:demo
    Vip6 String IPV6地址
    示例值:2402:4e00:40:40::2:2a6
    IspName String IPV6转换地址所属运营商
    示例值:BGP
    TranslatorStatus String 转换实例状态,限于CREATING,RUNNING,DELETING,MODIFYING
    示例值:RUNNING
    CreatedTime Timestamp ISO8601 IPV6转换实例创建时间
    示例值:2023-07-13T11:12:06Z
    Ip6RuleCount Integer 绑定的IPV6转换规则数量
    示例值:2
    IP6RuleSet Array of Ip6Rule IPV6转换规则信息

    IpAddressStates

    占用ip的资源信息

    被如下接口引用:DescribeUsedIpAddress。

    名称 类型 描述
    VpcId String VPC实例ID。
    示例值:vpc-mcqaoy0f
    SubnetId String 子网实例ID。
    示例值:subnet-j4oluywm
    IpAddress String IP地址。
    示例值:172.16.0.16
    ResourceType String 资源类型
    示例值:ENI
    ResourceId String 资源ID
    示例值:eni-bjekqff1

    IpField

    IP在线查询的字段信息

    被如下接口引用:DescribeIpGeolocationInfos。

    名称 类型 必选 描述
    Country Boolean 国家字段信息
    示例值:true
    Province Boolean 省、州、郡一级行政区域字段信息
    示例值:true
    City Boolean 市一级行政区域字段信息
    示例值:true
    Region Boolean 市内区域字段信息
    示例值:true
    Isp Boolean 接入运营商字段信息
    示例值:true
    AsName Boolean 骨干运营商字段信息
    示例值:true
    AsId Boolean 骨干As号
    示例值:true
    Comment Boolean 注释字段
    示例值:true

    IpGeolocationInfo

    IP地理位置信息

    被如下接口引用:DescribeIpGeolocationInfos。

    名称 类型 描述
    Country String 国家信息
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:中国
    Province String 省、州、郡一级行政区域信息
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:安徽省
    City String 市一级行政区域信息
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:未知
    Region String 市内区域信息
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:未知
    Isp String 接入运营商信息
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:中国电信
    AsName String 骨干运营商名称
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:中国电信
    AsId String 骨干运营商AS号
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:4134
    Comment String 注释信息。目前的填充值为移动接入用户的APN值,如无APN属性则为空
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NULL
    AddressIp String IP地址
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:223.246.170.250

    Ipv6Address

    IPv6地址信息。

    被如下接口引用:AssignIpv6Addresses, CreateAndAttachNetworkInterface, CreateNetworkInterface, DescribeNetworkInterfaces, ModifyIpv6AddressesAttribute, UnassignIpv6Addresses。

    名称 类型 必选 描述
    Address String IPv6地址,形如:3402:4e00:20:100:0:8cd9:2a67:71f3
    示例值:3402:4e00:20:1202::1
    Primary Boolean 是否是主IP
    示例值:false
    AddressId String EIP实例ID,形如:eip-hxlqja90
    示例值:eip-5k6fot41
    Description String 描述信息。
    示例值:demo
    IsWanIpBlocked Boolean 公网IP是否被封堵。
    示例值:false
    State String IPv6地址状态:
  • PENDING:生产中
  • MIGRATING:迁移中
  • DELETING:删除中
  • AVAILABLE:可用的

  • 示例值:AVAILABLE
    PublicIpAddress String 如果 IPv6地址是 ULA 类型,绑定的公网IP地址。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:3402:4e00:20:1202::2
    AddressType String IPv6地址的类型: GUA, OTHER, ULA
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:ULA

    Ipv6SubnetCidrBlock

    IPv6子网段对象。

    被如下接口引用:AssignIpv6SubnetCidrBlock, UnassignIpv6SubnetCidrBlock。

    名称 类型 必选 描述
    SubnetId String 子网实例ID。形如:subnet-pxir56ns
    示例值:subnet-kgpu7qt2
    Ipv6CidrBlock String IPv6子网段。形如:3402:4e00:20:1001::/64。作为AssignIpv6SubnetCidrBlock接口入参时,该参数必填。
    示例值:3402:4e00:20:1202::/64

    ItemPrice

    单项计费价格信息

    被如下接口引用:InquiryPriceCreateVpnGateway, InquiryPriceRenewVpnGateway, InquiryPriceResetVpnGatewayInternetMaxBandwidth。

    名称 类型 描述
    UnitPrice Float 按量计费后付费单价,单位:元。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1.0
    ChargeUnit String 按量计费后付费计价单元,可取值范围: HOUR:表示计价单元是按每小时来计算。当前涉及该计价单元的场景有:实例按小时后付费(POSTPAID_BY_HOUR)、带宽按小时后付费(BANDWIDTH_POSTPAID_BY_HOUR): GB:表示计价单元是按每GB来计算。当前涉及该计价单元的场景有:流量按小时后付费(TRAFFIC_POSTPAID_BY_HOUR)。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:HOUR
    OriginalPrice Float 预付费商品的原价,单位:元。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1.0
    DiscountPrice Float 预付费商品的折扣价,单位:元。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0.5

    LocalDestinationIpPortTranslationNatRule

    本端目的IP端口转换复杂结构

    被如下接口引用:CreatePrivateNatGatewayDestinationIpPortTranslationNatRule, DeletePrivateNatGatewayDestinationIpPortTranslationNatRule。

    名称 类型 必选 描述
    Protocol String 协议
    示例值:TCP
    OriginalPort Integer 源端口
    示例值:80
    OriginalIp String 源IP
    示例值:192.168.4.43
    TranslationPort Integer 目的端口
    示例值:80
    TranslationIp String 目的IP
    示例值:10.254.4.43
    Description String 描述
    示例值:webservice

    LocalGateway

    本地网关信息

    被如下接口引用:CreateLocalGateway, DescribeLocalGateway。

    名称 类型 描述
    CdcId String CDC实例ID
    示例值:cluster-gbo27yc4
    VpcId String VPC实例ID
    示例值:vpc-m0c2kcun
    UniqLocalGwId String 本地网关实例ID(计划弃用)
    示例值:lgw-1234erty
    LocalGatewayName String 本地网关名称
    示例值:demo
    LocalGwIp String 本地网关IP地址
    示例值:192.168.15.55
    CreateTime String 本地网关创建时间
    示例值:2021-03-24 15:31:56
    TagSet Array of Tag 标签键值对。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[]
    LocalGatewayId String 本地网关实例ID(计划起用)
    示例值:lgw-1234erty

    MemberInfo

    模板对象成员信息

    被如下接口引用:AddTemplateMember, DeleteTemplateMember, ModifyTemplateMember。

    名称 类型 必选 描述
    Member String 模板对象成员
    示例值:ipm-h0fk8lfc
    Description String 模板对象成员描述信息
    示例值:demo

    ModifyRouteTableInfo

    云联网路由表信息

    被如下接口引用:ModifyCcnRouteTables。

    名称 类型 必选 描述
    RouteTableId String 云联网路由表id。
    示例值:ccnrtb-245ecr35
    Name String 云联网路由表名称。Name和Description 两者必传一个。
    示例值:rtb-name
    Description String 云联网路由表描述。Name和Description 两者必传一个。
    示例值:rtb-desc

    NatDirectConnectGatewayRoute

    查询nat路由的返回路由对象

    被如下接口引用:DescribeNatGatewayDirectConnectGatewayRoute。

    名称 类型 描述
    DestinationCidrBlock String 子网的 IPv4 CIDR
    示例值:99.99.99.77/32
    GatewayType String 下一跳网关的类型,目前此接口支持的类型有:
    DIRECTCONNECT:专线网关
    示例值:DIRECTCONNECT
    GatewayId String 下一跳网关ID
    示例值:dcg-71awizmv
    CreateTime Timestamp 路由的创建时间
    示例值:2021-08-23 19:38:31
    UpdateTime Timestamp 路由的更新时间
    示例值:021-08-23 19:38:31

    NatGateway

    NAT网关对象。

    被如下接口引用:CreateNatGateway, DescribeNatGateways。

    名称 类型 描述
    NatGatewayId String NAT网关的ID。
    示例值:"nat-12345678"
    NatGatewayName String NAT网关的名称。
    示例值:"test"
    CreatedTime String NAT网关创建的时间。
    示例值:"2021-05-24 19:28:31"
    State String NAT网关的状态。
    'PENDING':生产中,'DELETING':删除中/子实例关闭中,'AVAILABLE':运行中,'UPDATING':升级中,
    ‘PENDFAILURE’:创建失败,‘DELETEFAILURE:删除失败,‘DENIED’:子实例关闭中
    示例值:"AVAILABLE"
    InternetMaxBandwidthOut Integer 网关最大外网出带宽(单位:Mbps)。
    示例值:10
    MaxConcurrentConnection Integer 网关并发连接上限。
    示例值:10000000
    PublicIpAddressSet Array of NatGatewayAddress 绑定NAT网关的公网IP对象数组。
    示例值: 无
    NetworkState String NAT网关网络状态。“AVAILABLE”:运行中, “UNAVAILABLE”:不可用, “INSUFFICIENT”:欠费停服。
    示例值:"AVAILABLE"
    DestinationIpPortTranslationNatRuleSet Array of DestinationIpPortTranslationNatRule NAT网关的端口转发规则。
    VpcId String VPC实例ID。
    示例值:"vpc-12345678"
    Zone String NAT网关所在的可用区。
    示例值:"ap-guangzhou-2"
    DirectConnectGatewayIds Array of String 绑定的专线网关ID。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:["dcg-12345678"]
    SubnetId String 所属子网ID。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:"subnet-12345678"
    TagSet Array of Tag 标签键值对。
    SecurityGroupSet Array of String NAT网关绑定的安全组列表
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:["sg-12345678"]
    SourceIpTranslationNatRuleSet Array of SourceIpTranslationNatRule NAT网关的SNAT转发规则。
    注意:此字段可能返回 null,表示取不到有效值。
    IsExclusive Boolean 是否独享型NAT。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:true
    ExclusiveGatewayBandwidth Integer 独享型NAT所在的网关集群的带宽(单位:Mbps),当IsExclusive为false时无此字段。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:50000
    RestrictState String NAT网关是否被封禁。“NORMAL”:未被封禁,“RESTRICTED”:已被封禁。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NORMAL
    NatProductVersion Integer NAT网关类型,1表示传统型NAT网关,2表示标准型NAT网关
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    SmartScheduleMode Boolean 是否启用根据目的网段选择SNAT使用的EIP功能
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:false
    DedicatedClusterId String NAT实例归属的专属集群id
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:cluster-bxdip3ah

    NatGatewayAddress

    NAT网关绑定的弹性IP

    被如下接口引用:CreateNatGateway, DescribeNatGateways。

    名称 类型 描述
    AddressId String 弹性公网IP(EIP)的唯一 ID,形如:eip-11112222
    示例值:eip-11112222
    PublicIpAddress String 外网IP地址,形如:123.121.34.33
    示例值:123.121.34.3
    IsBlocked Boolean 资源封堵状态。true表示弹性ip处于封堵状态,false表示弹性ip处于未封堵状态。
    示例值:true
    BlockType String 资源封堵类型。NORMAL表示未封禁,SECURITY表示安全封禁,USER表示用户封禁,OTHER表示其他封禁,多个原因封禁时用&连接,比如:SECURITY&USER&OTHER。
    示例值:SECURITY&USER

    NatGatewayDestinationIpPortTranslationNatRule

    NAT网关的端口转发规则

    被如下接口引用:DescribeNatGatewayDestinationIpPortTranslationNatRules。

    名称 类型 描述
    IpProtocol String 网络协议,可选值:TCPUDP
    示例值:TCP
    PublicIpAddress String 弹性公网IP。
    示例值:123.123.123.123
    PublicPort Integer 公网端口。
    示例值:443
    PrivateIpAddress String 内网地址。
    示例值:192.168.1.2
    PrivatePort Integer 内网端口。
    示例值:443
    Description String NAT网关转发规则描述。
    示例值:端口转发样例
    NatGatewayId String NAT网关的ID。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:nat-3isn9hr0
    VpcId String 私有网络VPC的ID。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:vpc-abcdefgh
    CreatedTime String NAT网关转发规则创建时间。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:"2021-05-24 19:28:31"

    NatRegionInfoWithArea

    NAT地域地区对象

    被如下接口引用:DescribePrivateNatGatewayRegions。

    名称 类型 描述

    NetDetect

    网络探测对象。

    被如下接口引用:CreateNetDetect, DescribeNetDetects。

    名称 类型 描述
    VpcId String VPC实例ID。形如:vpc-12345678
    示例值:vpc-5k6fot41
    VpcName String VPC实例名称。
    示例值:demo
    SubnetId String 子网实例ID。形如:subnet-12345678。
    示例值:subnet-kgpu7qt2
    SubnetName String 子网实例名称。
    示例值:demo
    NetDetectId String 网络探测实例ID。形如:netd-12345678。
    示例值:netd-csnmo39l
    NetDetectName String 网络探测名称,最大长度不能超过60个字节。
    示例值:demo
    DetectDestinationIp Array of String 探测目的IPv4地址数组,最多两个。
    示例值:["10.0.0.10"]
    DetectSourceIp Array of String 系统自动分配的探测源IPv4数组。长度为2。
    示例值:["10.0.0.12", "10.0.0.13"]
    NextHopType String 下一跳类型,目前我们支持的类型有:
    VPN:VPN网关;
    DIRECTCONNECT:专线网关;
    PEERCONNECTION:对等连接;
    NAT:NAT网关;
    NORMAL_CVM:普通云服务器;
    CCN:云联网网关;
    NONEXTHOP:无下一跳;
    示例值:NORMAL_CVM
    NextHopDestination String 下一跳目的网关,取值与“下一跳类型”相关:
    下一跳类型为VPN,取值VPN网关ID,形如:vpngw-12345678;
    下一跳类型为DIRECTCONNECT,取值专线网关ID,形如:dcg-12345678;
    下一跳类型为PEERCONNECTION,取值对等连接ID,形如:pcx-12345678;
    下一跳类型为NAT,取值Nat网关,形如:nat-12345678;
    下一跳类型为NORMAL_CVM,取值云服务器IPv4地址,形如:10.0.0.12;
    下一跳类型为CCN,取值云联网ID,形如:ccn-12345678;
    下一跳类型为NONEXTHOP,指定网络探测为无下一跳的网络探测,添加和修改时,不需要指定值,查询时值为空字符串;
    示例值:10.0.0.4
    NextHopName String 下一跳网关名称。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:demo
    NetDetectDescription String 网络探测描述。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:demo
    CreateTime Timestamp 创建时间。
    示例值:2019-09-11 10:00:00
    TagSet Array of Tag 标签键值对。
    示例值:[{"Key": "env", "Value": "prod"}]

    NetDetectIpState

    网络探测目的IP的验证结果。

    被如下接口引用:CheckNetDetectState, DescribeNetDetectStates。

    名称 类型 描述
    DetectDestinationIp String 探测目的IPv4地址。
    示例值:10.0.0.10
    State Integer 探测结果。
    0:成功;
    -1:查询不到路由丢包;
    -2:外出ACL丢包;
    -3:IN ACL丢包;
    -4:其他错误;
    示例值:0
    Delay Integer 时延,单位毫秒
    示例值:2
    PacketLossRate Integer 丢包率
    示例值:0

    NetDetectState

    网络探测验证结果。

    被如下接口引用:DescribeNetDetectStates。

    名称 类型 描述
    NetDetectId String 网络探测实例ID。形如:netd-12345678。
    示例值:netd-r0g2kty7
    NetDetectIpStateSet Array of NetDetectIpState 网络探测目的IP验证结果对象数组。
    示例值:[{"DetectDestinationIp": "10.0.0.10", "State": 0, "Delay": 0, "PacketLossRate": 0}]

    NetworkAcl

    网络ACL

    被如下接口引用:CreateNetworkAcl, DescribeNetworkAcls。

    名称 类型 描述
    VpcId String VPC实例ID
    示例值:vpc-5k6fot41
    NetworkAclId String 网络ACL实例ID
    示例值:acl-kgpu7qt2
    NetworkAclName String 网络ACL名称,最大长度为60。
    示例值:demo
    CreatedTime String 创建时间。
    示例值:2021-03-22 20:59:55
    SubnetSet Array of Subnet 网络ACL关联的子网数组。
    示例值:[]
    IngressEntries Array of NetworkAclEntry 该参数仅对三元组ACL有效,网络ACl入站规则。
    示例值:[]
    EgressEntries Array of NetworkAclEntry 该参数仅对三元组ACL有效,网络ACL出站规则。
    示例值:[]
    NetworkAclType String 网络ACL类型。三元组:'TRIPLE' 五元组:'QUINTUPLE'
    示例值:TRIPLE
    TagSet Array of Tag 标签键值对
    示例值:[]

    NetworkAclEntry

    网络ACL规则。

    被如下接口引用:CreateNetworkAcl, CreateNetworkAclEntries, DeleteNetworkAclEntries, DescribeNetworkAcls, ModifyNetworkAclEntries。

    名称 类型 必选 描述
    Protocol String 协议, 取值: TCP,UDP, ICMP, ALL。
    示例值:TCP
    Port String 端口(all, 单个port, range)。当Protocol为ALL或ICMP时,不能指定Port。使用-指定端口范围,如:10-20。
    示例值:8080
    CidrBlock String 网段或IP(互斥)。增量创建ACL规则时,CidrBlock和Ipv6CidrBlock至少提供一个。
    示例值:10.0.0.0/24
    Ipv6CidrBlock String 网段或IPv6(互斥)。
    示例值:3402:4e00:20:1200::/56
    Action String ACCEPT 或 DROP。
    示例值:ACCEPT
    Description String 规则描述,最大长度100。
    示例值:demo
    ModifyTime String 修改时间。
    示例值:2018-04-25 10:26:26
    Priority Integer 优先级,从1开始。
    示例值:1
    NetworkAclIpv4EntryId String IPv4网络ACL条目唯一ID。当修改ACL条目时,NetworkAclIpv4EntryId和NetworkAclIpv6EntryID至少提供一个。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:acli43-0pngbwph
    NetworkAclIpv6EntryId String IPv6网络ACL条目唯一ID。当修改ACL条目时,NetworkAclIpv4EntryId和NetworkAclIpv6EntryId至少提供一个。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:acli46-0pngbwph

    NetworkAclEntrySet

    网络ACL规则集合

    被如下接口引用:CreateNetworkAclEntries, DeleteNetworkAclEntries, ModifyNetworkAclEntries。

    名称 类型 必选 描述
    Ingress Array of NetworkAclEntry 入站规则。
    Egress Array of NetworkAclEntry 出站规则。

    NetworkAclQuintupleEntries

    网络ACL五元组

    被如下接口引用:CreateNetworkAclQuintupleEntries, DeleteNetworkAclQuintupleEntries, ModifyNetworkAclEntries, ModifyNetworkAclQuintupleEntries。

    名称 类型 必选 描述
    Ingress Array of NetworkAclQuintupleEntry 网络ACL五元组入站规则。
    示例值:[{ 'SourcePort':'446', 'SourceCidr': '10.0.0.2/24', 'Protocol':
    Egress Array of NetworkAclQuintupleEntry 网络ACL五元组出站规则
    示例值:[{ 'SourcePort':'446', 'SourceCidr': '10.0.0.2/24', 'Protocol':

    NetworkAclQuintupleEntry

    网络ACL五元组Entry

    被如下接口引用:CreateNetworkAclQuintupleEntries, DeleteNetworkAclQuintupleEntries, DescribeNetworkAclQuintupleEntries, ModifyNetworkAclEntries, ModifyNetworkAclQuintupleEntries。

    名称 类型 必选 描述
    Protocol String 协议, 取值: TCP,UDP, ICMP, ALL。
    示例值:UDP
    Description String 描述。
    示例值:demo
    SourcePort String 源端口(all, 单个port, range)。当Protocol为ALL或ICMP时,不能指定Port。
    示例值:446
    SourceCidr String 源CIDR。
    示例值:192.168.0.0/24
    DestinationPort String 目的端口(all, 单个port, range)。当Protocol为ALL或ICMP时,不能指定Port。
    示例值:446
    DestinationCidr String 目的CIDR。
    示例值:192.168.0.0/24
    Action String 动作,ACCEPT 或 DROP。
    示例值:ACCEPT
    NetworkAclQuintupleEntryId String 网络ACL条目唯一ID。
    示例值:acli45-ahnu4rv5
    Priority Integer 优先级,从1开始。
    示例值:1
    CreateTime String 创建时间,用于DescribeNetworkAclQuintupleEntries的出参。
    示例值:2021-03-02 14:41:15
    NetworkAclDirection String 方向,INGRESS或EGRESS,用于DescribeNetworkAclQuintupleEntries的出参。
    示例值:INGRESS

    NetworkInterface

    弹性网卡

    被如下接口引用:CreateAndAttachNetworkInterface, CreateNetworkInterface, DescribeNetworkInterfaces。

    名称 类型 必选 描述
    NetworkInterfaceId String 弹性网卡实例ID,例如:eni-f1xjkw1b。
    示例值:eni-b4ax8qbz
    NetworkInterfaceName String 弹性网卡名称。
    示例值:demo
    NetworkInterfaceDescription String 弹性网卡描述。
    示例值:demo
    SubnetId String 子网实例ID。
    示例值:subnet-l0ykcjvi
    VpcId String VPC实例ID。
    示例值:vpc-29mdigub
    GroupSet Array of String 绑定的安全组。
    示例值:["sg-2edhcclz"]
    Primary Boolean 是否是主网卡。
    示例值:true
    MacAddress String MAC地址。
    示例值:20:90:6F:EE:57:E2
    State String 弹性网卡状态:
  • PENDING:创建中
  • AVAILABLE:可用的
  • ATTACHING:绑定中
  • DETACHING:解绑中
  • DELETING:删除中

  • 示例值:AVAILABLE
    NetworkInterfaceState String 弹性网卡状态:
  • PENDING:创建中
  • AVAILABLE:可用的
  • ATTACHING:绑定中
  • DETACHING:解绑中
  • DELETING:删除中
  • INUSE:已绑定

  • 示例值:AVAILABLE
    PrivateIpAddressSet Array of PrivateIpAddressSpecification 内网IP信息。
    示例值:[{"PrivateIpAddress": "192.168.0.10"}]
    Attachment NetworkInterfaceAttachment 绑定的云服务器对象。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:ins-ikgdajbc
    Zone String 可用区。
    示例值:ap-guangzhou-1
    CreatedTime String 创建时间。
    示例值:2020-10-28 08:23:59
    Ipv6AddressSet Array of Ipv6Address IPv6地址列表。
    示例值:[{"Description": "", "Primary": false, "Address": "3402:4e00:20:1202::1", "AddressId": "", "PublicIpAddress": "", "IsWanIpBlocked": false, "State": "AVAILABLE", "AddressType": "GUA"}]
    TagSet Array of Tag 标签键值对。
    示例值:[{"Key": "env", "Value": "prod"}]
    EniType Integer 网卡类型。0 - 弹性网卡;1 - evm弹性网卡。
    示例值:0
    Business String 网卡绑定的子机类型:cvm,eks。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:TKE
    CdcId String 网卡所关联的CDC实例ID。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:cluster-gbo27yc4
    AttachType Integer 弹性网卡类型:0:标准型/1:扩展型。默认值为0。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    ResourceId String 用于保留网卡主IP的资源ID用于保留网卡主IP的资源ID。用于删除网卡时作为入参数。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:cls-j85c20d4-reserved
    QosLevel String 服务质量级别:
  • DEFAULT:默认
  • PT:云金
  • AU:云银
  • AG:云铜

  • 注意:此字段可能返回 null,表示取不到有效值。
    示例值:AG

    NetworkInterfaceAttachment

    弹性网卡绑定关系

    被如下接口引用:CreateAndAttachNetworkInterface, CreateNetworkInterface, DescribeNetworkInterfaces。

    名称 类型 必选 描述
    DeviceIndex Integer 网卡在云主机实例内的序号。
    示例值:1
    InstanceAccountId String 云主机所有者账户信息。
    示例值:251000681
    AttachTime String 绑定时间。
    示例值:2020-10-12 10:00:00
    InstanceId String 云主机实例ID。
    示例值:ins-6o1wqibe

    PeerConnection

    对等连接实例信息。

    被如下接口引用:DescribeVpcPeeringConnections。

    名称 类型 描述
    SourceVpcId String 本端VPC唯一ID。
    示例值:vpc-test1234
    PeerVpcId String 对端VPC唯一ID。
    示例值:vpc-test5678
    PeeringConnectionId String 对等连接唯一ID。
    示例值:pcx-test1234
    PeeringConnectionName String 对等连接名称。
    示例值:Example
    State String 对等连接状态,PENDING,投放中;ACTIVE,使用中;REJECTED,已拒绝‘DELETED,已删除;FAILED,失败;EXPIRED,已过期;ISOLATED,隔离中。
    示例值:PEDNING
    IsNgw Boolean 是否是新控制器,true: 是NewAfc;false:不是。
    示例值:true
    Bandwidth Integer 对等连接带宽值。
    示例值:10
    SourceRegion String 本端地域。
    示例值:gz
    DestinationRegion String 对端地域。
    示例值:sh
    CreateTime String 创建时间。
    示例值:2019-01-15 11:07:15
    AppId Integer 本端APPID。
    示例值:120777408
    PeerAppId Integer 对端APPID。
    示例值:120777408
    ChargeType String 计费类型,POSTPAID_BY_DAY_MAX:日峰值计费;POSTPAID_BY_MONTH_95:月95计费。
    示例值:POSTPAID_BY_DAY_MAX
    SourceUin Integer 本端UIN。
    示例值:1307774067
    DestinationUin Integer 对端UIN。
    示例值:1307774067
    TagSet Array of Tag 资源标签数据。
    示例值:[{"Key": "test", "Value":"test"}]
    QosLevel String 服务分级:PT、AU、AG。
    示例值:AU
    Type String 互通类型,VPC_PEER:VPC间互通;VPC_BM_PEER:VPC与黑石网络互通。
    示例值:VPC_PEER
    DestinationVpcId String 对端VPC唯一ID。
    示例值:vpc-test5678

    PolicyStatistics

    安全组策略统计

    被如下接口引用:CreateSecurityGroupPolicies, CreateSecurityGroupWithPolicies, DeleteSecurityGroupPolicies, DescribeSecurityGroupPolicies, ModifySecurityGroupPolicies, ReplaceSecurityGroupPolicies, ReplaceSecurityGroupPolicy。

    名称 类型 必选 描述
    IngressIPv4TotalCount Integer 入站IPv4总数
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    IngressIPv6TotalCount Integer 入站IPv6总数
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    EgressIPv4TotalCount Integer 出站IPv4总数
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    EgressIPv6TotalCount Integer 出站IPv6总数
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1

    Price

    价格

    被如下接口引用:InquiryPriceCreateVpnGateway, InquiryPriceRenewVpnGateway, InquiryPriceResetVpnGatewayInternetMaxBandwidth。

    名称 类型 描述
    InstancePrice ItemPrice 实例价格。
    示例值:{'UnitPrice': 0.58, 'ChargeUnit': 'HOUR', 'OriginalPrice': 0.58, 'DiscountPrice': 0.28}
    BandwidthPrice ItemPrice 带宽价格。
    示例值:{'UnitPrice': 1, 'ChargeUnit': 'GB', 'OriginalPrice': 1.0, 'DiscountPrice': 0.46}

    PrivateIpAddressSpecification

    内网IP信息

    被如下接口引用:AssignPrivateIpAddresses, CreateAndAttachNetworkInterface, CreateNetworkInterface, DescribeNetworkInterfaces, ModifyPrivateIpAddressesAttribute, UnassignPrivateIpAddresses。

    名称 类型 必选 描述
    PrivateIpAddress String 内网IP地址。
    示例值:192.168.0.10
    Primary Boolean 是否是主IP。
    示例值:false
    PublicIpAddress String 公网IP地址。
    示例值:123.10.100.171
    AddressId String EIP实例ID,例如:eip-11112222。
    示例值:eip-29mdigub
    Description String 内网IP描述信息。
    示例值:demo
    IsWanIpBlocked Boolean 公网IP是否被封堵。
    示例值:false
    State String IP状态:
    PENDING:生产中
    MIGRATING:迁移中
    DELETING:删除中
    AVAILABLE:可用的
    示例值:AVAILABLE
    QosLevel String IP服务质量等级,可选值:PT、AU、AG、DEFAULT,分别代表云金、云银、云铜、默认四个等级。
    示例值:PT

    PrivateNatCrossDomainInfo

    私网NAT网关跨域信息

    被如下接口引用:CreatePrivateNatGateway, DescribePrivateNatGateways。

    名称 类型 描述
    CcnId String 跨域私网NAT关联的云联网ID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:ccn-4as5s8ga
    LocalVpcId String 跨域私网NAT本端Vpc
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:vpc-noam856a
    PeerVpcId String 跨域私网NAT对端Vpc
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:vpc-noam856a

    PrivateNatDestinationIpPortTranslationNatRule

    本端目的IP端口转换复杂结构

    被如下接口引用:DescribePrivateNatGatewayDestinationIpPortTranslationNatRules。

    名称 类型 必选 描述
    Protocol String 协议
    示例值:"TCP"
    OriginalPort Integer 原端口
    示例值:80
    OriginalIp String 原IP
    示例值:"10.0.13.20"
    TranslationPort Integer 映射端口
    示例值:8081
    TranslationIp String 映射IP
    示例值:"10.0.13.20"
    Description String 描述
    示例值:webservice
    CreateTime String 创建时间。
    示例值:"2022-09-30 14:24:38"
    UpdateTime String 更新时间。
    示例值:"2022-09-30 14:24:38"

    PrivateNatGateway

    私网网关对象

    被如下接口引用:CreatePrivateNatGateway, DescribePrivateNatGateways。

    名称 类型 描述
    NatGatewayId String 私网网关ID
    示例值:intranat-0g3blj80
    NatGatewayName String 私网网关名称。
    示例值:PrivateDemo
    VpcId String 私网网关关联VPC实例ID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:vpc-noanwmed
    Status String 私网网关当前状态。
    示例值:AVAILABLE
    CrossDomain Boolean 私网网关跨域标志。
    示例值:True
    CreatedTime String 创建时间
    示例值:2022-09-29 15:58:00
    TagSet Array of Tag 标签键值对。
    注意:此字段可能返回 null,表示取不到有效值。
    DirectConnectGatewayIds Array of String 专线网关唯一ID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:["dcg-asdf891z"]
    NatType String 私网网关类型
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:DCG
    CrossDomainInfo PrivateNatCrossDomainInfo 私网NAT跨域信息
    注意:此字段可能返回 null,表示取不到有效值。
    VpcType Boolean 是否VPC型私网网关
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:True
    CcnId String 跨域私网NAT关联的云联网ID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:ccn-asj6o7cd

    PrivateNatGatewayLimit

    可创建的私网网关配额数量

    被如下接口引用:DescribePrivateNatGatewayLimits。

    名称 类型 描述
    UniqVpcId String 私有网络唯一ID
    示例值:vpc-12345678
    TotalLimit Integer Vpc下总计可创建私网网关数量。
    示例值:1000
    Available Integer 可创建私网网关数量。
    示例值:0

    ProductQuota

    描述网络中心每个产品的配额信息

    被如下接口引用:DescribeProductQuota。

    名称 类型 描述
    QuotaId String 产品配额ID
    示例值:0
    QuotaName String 产品配额名称
    示例值:每个开发商可创建的VPC数
    QuotaCurrent Integer 产品当前配额
    示例值:10
    QuotaLimit Integer 产品配额上限
    示例值:100
    QuotaRegion Boolean 产品配额是否有地域属性
    示例值:True

    Quota

    描述配额信息

    被如下接口引用:DescribeAddressQuota, DescribeBandwidthPackageQuota, DescribeIp6TranslatorQuota。

    名称 类型 描述
    QuotaId String 配额名称,取值范围:
    - TOTAL_EIP_QUOTA:用户当前地域下EIP的配额数;
    - DAILY_EIP_APPLY:用户当前地域下今日申购次数;
    - DAILY_PUBLIC_IP_ASSIGN:用户当前地域下,重新分配公网 IP次数;
    - TOTAL_EIP6_QUOTA:用户当前地域下,传统弹性公网IPv6的配额数;
    - BGP_EIPv6_QUOTA:用户当前地域下,可申请的 BGP 弹性公网IPv6 的配额数;
    - SINGLEISP_EIPv6_QUOTA:用户当前地域下,可申请的静态单线弹性公网IPv6 的配额数;
    示例值:TOTAL_EIP_QUOTA
    QuotaCurrent Integer 当前数量
    示例值:10
    QuotaLimit Integer 配额数量
    示例值:20
    QuotaGroup String 配额所属的网络组
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:ap-guangzhou

    ReferredSecurityGroup

    安全组被引用信息

    被如下接口引用:DescribeSecurityGroupReferences。

    名称 类型 描述
    SecurityGroupId String 安全组实例ID。
    示例值:sg-pnpcflil
    ReferredSecurityGroupIds Array of String 引用安全组实例ID(SecurityGroupId)的所有安全组实例ID。
    示例值:["sg-nswq8wkq"]

    ReserveIpAddressInfo

    内网保留IP数据

    被如下接口引用:CreateReserveIpAddresses, DescribeReserveIpAddresses。

    名称 类型 描述
    ReserveIpId String 内网保留IP唯一 ID。
    示例值:rsvip-calhlymy
    VpcId String VPC唯一 ID。
    示例值:vpc-mcqaoy0f
    SubnetId String 子网唯一 ID。
    示例值:subnet-j4oluywm
    ReserveIpAddress String 内网保留IP地址。
    示例值:172.16.0.21
    ResourceId String 内网保留 IP绑定的资源实例 ID。
    示例值:eni-8zugogrv
    IpType Integer 产品申请的IpType。
    示例值:0
    State String 绑定状态,UnBind-未绑定, Bind-绑定。
    示例值: UnBind
    Name String 保留 IP名称。
    示例值:name_ip
    Description String 保留 IP描述。
    示例值:desc_ip
    CreatedTime String 创建时间。
    示例值:2021-03-02 14:41:15
    TagSet Array of Tag 标签键值对。
    示例值:[ { "Key": "ivan_tag", "Value": "hello" } ]

    Resource

    描述带宽包资源信息的结构

    被如下接口引用:DescribeBandwidthPackageResources, DescribeBandwidthPackages。

    名称 类型 描述
    ResourceType String 带宽包资源类型,包括'Address'和'LoadBalance'
    示例值:Address
    ResourceId String 带宽包资源Id,形如'eip-xxxx', 'lb-xxxx'
    示例值:eip-d97psd1o
    AddressIp String 带宽包资源Ip
    示例值:139.199.XX.XX

    ResourceDashboard

    VPC资源看板(各资源个数)

    被如下接口引用:DescribeVpcResourceDashboard。

    名称 类型 描述
    VpcId String Vpc实例ID,例如:vpc-bq4bzxpj。
    示例值:vpc-bq4bzxpj
    SubnetId String 子网实例ID,例如:subnet-bthucmmy。
    示例值:subnet-bthucmmy
    Classiclink Integer 基础网络互通。
    示例值:0
    Dcg Integer 专线网关。
    示例值:1
    Pcx Integer 对等连接。
    示例值:0
    Ip Integer 统计当前除云服务器 IP、弹性网卡IP和网络探测IP以外的所有已使用的IP总数。云服务器 IP、弹性网卡IP和网络探测IP单独计数。
    示例值:0
    Nat Integer NAT网关。
    示例值:1
    Vpngw Integer VPN网关。
    示例值:0
    FlowLog Integer 流日志。
    示例值:0
    NetworkDetect Integer 网络探测。
    示例值:0
    NetworkACL Integer 网络ACL。
    示例值:0
    CVM Integer 云主机。
    示例值:2
    LB Integer 负载均衡。
    示例值:0
    CDB Integer 关系型数据库。
    示例值:0
    Cmem Integer 云数据库 TencentDB for Memcached。
    示例值:0
    CTSDB Integer 时序数据库。
    示例值:0
    MariaDB Integer 数据库 TencentDB for MariaDB(TDSQL)。
    示例值:0
    SQLServer Integer 数据库 TencentDB for SQL Server。
    示例值:0
    Postgres Integer 云数据库 TencentDB for PostgreSQL。
    示例值:0
    NAS Integer 网络附加存储。
    示例值:0
    Greenplumn Integer Snova云数据仓库。
    示例值:0
    Ckafka Integer 消息队列 CKAFKA。
    示例值:0
    Grocery Integer Grocery。
    示例值:0
    HSM Integer 数据加密服务。
    示例值:0
    Tcaplus Integer 游戏存储 Tcaplus。
    示例值:0
    Cnas Integer Cnas。
    示例值:0
    TiDB Integer HTAP 数据库 TiDB。
    示例值:0
    Emr Integer EMR 集群。
    示例值:0
    SEAL Integer SEAL。
    示例值:0
    CFS Integer 文件存储 CFS。
    示例值:0
    Oracle Integer Oracle。
    示例值:0
    ElasticSearch Integer ElasticSearch服务。
    示例值:0
    TBaaS Integer 区块链服务。
    示例值:0
    Itop Integer Itop。
    示例值:0
    DBAudit Integer 云数据库审计。
    示例值:0
    CynosDBPostgres Integer 企业级云数据库 CynosDB for Postgres。
    示例值:0
    Redis Integer 数据库 TencentDB for Redis。
    示例值:0
    MongoDB Integer 数据库 TencentDB for MongoDB。
    示例值:0
    DCDB Integer 分布式数据库 TencentDB for TDSQL。
    示例值:0
    CynosDBMySQL Integer 企业级云数据库 CynosDB for MySQL。
    示例值:0
    Subnet Integer 子网。
    示例值:1
    RouteTable Integer 路由表。
    示例值:1

    ResourceStatistics

    资源统计信息

    被如下接口引用:DescribeSubnetResourceDashboard。

    名称 类型 描述
    VpcId String Vpc实例ID,例如:vpc-f1xjkw1b。
    示例值:vpc-pnpcflil
    SubnetId String 子网实例ID,例如:subnet-bthucmmy。
    示例值:subnet-nswq8wkq
    Ip Integer 当前已使用的IP总数。
    示例值:100
    ResourceStatisticsItemSet Array of ResourceStatisticsItem 资源统计信息。
    示例值:[{"ResourceType": "CVM", "ResourceName": "云服务器", "ResourceCount": 100}]

    ResourceStatisticsItem

    资源统计项。

    被如下接口引用:DescribeSubnetResourceDashboard。

    名称 类型 描述
    ResourceType String 资源类型。比如,CVM,ENI等。
    示例值:CVM
    ResourceName String 资源名称。
    示例值:云服务器
    ResourceCount Integer 资源个数。
    示例值:100

    Route

    路由策略对象

    被如下接口引用:CreateRouteTable, CreateRoutes, DeleteRoutes, DescribeRouteConflicts, DescribeRouteList, DescribeRouteTables, DescribeRoutes, ReplaceRoutes, ResetRoutes。

    名称 类型 必选 描述
    DestinationCidrBlock String 创建IPv4目的网段,取值不能在私有网络网段内,例如:112.20.51.0/24。
    示例值:10.0.0.0/24
    GatewayType String 下一跳类型,目前我们支持的类型有:
    CVM:公网网关类型的云服务器;
    VPN:VPN网关;
    DIRECTCONNECT:专线网关;
    PEERCONNECTION:对等连接;
    HAVIP:高可用虚拟IP;
    NAT:公网NAT网关;
    NORMAL_CVM:普通云服务器;
    EIP:云服务器的公网IP;
    LOCAL_GATEWAY:CDC本地网关;
    INTRANAT:私网NAT网关;
    USER_CCN;云联网(自定义路由)。

    示例值:CCN
    GatewayId String 下一跳地址,这里只需要指定不同下一跳类型的网关ID,系统会自动匹配到下一跳地址。
    特殊说明:
    GatewayType为NORMAL_CVM时,GatewayId填写实例的内网IP。
    GatewayType为EIP时,GatewayId填写0。
    示例值:ccn-e187un9p
    RouteId Integer 路由策略ID。IPv4路由策略ID是有意义的值,IPv6路由策略是无意义的值0。后续建议完全使用字符串唯一ID RouteItemId操作路由策略。
    该字段在删除时必填,其他字段无需填写。
    示例值:1289089
    RouteDescription String 路由策略描述。
    示例值:demo
    Enabled Boolean 是否启用
    示例值:true
    RouteType String 路由类型,目前我们支持的类型有:
    USER:用户路由;
    NETD:网络探测路由,创建网络探测实例时,系统默认下发,不可编辑与删除;
    CCN:云联网路由,系统默认下发,不可编辑与删除。
    用户只能添加和操作 USER 类型的路由。
    示例值:CCN
    RouteTableId String 路由表实例ID,例如:rtb-azd4dt1c。
    示例值:rtb-azd4dt1c
    DestinationIpv6CidrBlock String 创建IPv6目的网段,取值不能在私有网络网段内,例如:2402:4e00:1000:810b::/64。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:3402:4e00:20:1200::/56
    RouteItemId String 路由唯一策略ID。
    示例值:rti-9bjer08h
    PublishedToVbc Boolean 路由策略是否发布到云联网。该字段仅做出参使用,作为入参字段时此参数不生效。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:true
    CreatedTime Timestamp 路由策略创建时间
    示例值:2021-03-02 14:41:15
    CdcId String CDC 集群唯一 ID。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:cluster-d8htgb6k

    RouteConflict

    路由冲突对象

    被如下接口引用:DescribeRouteConflicts。

    名称 类型 描述
    RouteTableId String 路由表实例ID,例如:rtb-azd4dt1c。
    示例值:rtb-4t7fr3fi
    DestinationCidrBlock String 要检查的与之冲突的目的端
    示例值:10.0.0.0/24
    ConflictSet Array of Route 冲突的路由策略列表
    示例值:[]

    RouteECMPAlgorithm

    用于修改入路由表ECMP算法。现在支持的算法有:ECMP_QUINTUPLE_HASH:五元组hash,ECMP_SOURCE_DESTINATION_IP_HASH:源和目的IP hash,ECMP_DESTINATION_IP_HASH:目的IP hash,ECMP_SOURCE_IP_HASH:源IP hash。

    被如下接口引用:ModifyHighPriorityRouteECMPAlgorithm。

    名称 类型 必选 描述
    DestinationCidrBlock String 目标网段
    注意:此字段可能返回 null,表示取不到有效值。
    示例值: 10.0.0.0/24
    SubnetRouteAlgorithm String 支持的 ECMP算法有:ECMP_QUINTUPLE_HASH:五元组hash,ECMP_SOURCE_DESTINATION_IP_HASH:源和目的IP hash,ECMP_DESTINATION_IP_HASH:目的IP hash,ECMP_SOURCE_IP_HASH:源IP hash。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:ECMP_SOURCE_DESTINATION_IP_HASH

    RouteSelectionPolicy

    路由表选择策略信息

    被如下接口引用:DescribeRouteTableSelectionPolicies。

    名称 类型 描述
    CcnId String 云联网ID。
    示例值:ccn-245ecr35
    RouteTableId String 路由表ID。
    示例值:ccnrtb-1234edfr
    RouteTableName String 路由表名称。
    示例值:34tgrdgs
    InstanceType String 实例类型。如VPC
    示例值:VPC
    InstanceName String 实例名称。
    示例值:tesetsa
    SourceCidrBlock String 源端cidr。
    示例值:10.0.0.0/16
    Description String 路由表描述。
    示例值:policy-desc
    InstanceId String 实例ID。
    示例值:vpc-m0c2kcun
    InstanceUin String 关联实例所属UIN(根账号)。
    示例值:100000072292

    RouteTable

    路由表对象

    被如下接口引用:CreateRouteTable, CreateRoutes, DescribeRouteTables。

    名称 类型 描述
    VpcId String VPC实例ID。
    示例值:vpc-m0c2kcun
    RouteTableId String 路由表实例ID,例如:rtb-azd4dt1c。
    示例值:rtb-32kbqgtm
    RouteTableName String 路由表名称。
    示例值:demo
    AssociationSet Array of RouteTableAssociation 路由表关联关系。
    示例值:10.0.0.0/16
    RouteSet Array of Route IPv4路由策略集合。
    示例值:[]
    Main Boolean 是否默认路由表。
    示例值:True
    CreatedTime String 创建时间。
    示例值:2010-11-21
    TagSet Array of Tag 标签键值对。
    示例值:[{"Key": "env", "Value": "prod"}]
    LocalCidrForCcn Array of CidrForCcn local路由是否发布云联网。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[]

    RouteTableAssociation

    路由表关联关系

    被如下接口引用:CreateRouteTable, CreateRoutes, DescribeRouteTables。

    名称 类型 描述
    SubnetId String 子网实例ID。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:subnet-4t7fr3fi
    RouteTableId String 路由表实例ID。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:rtb-h0fk8lfc

    SecurityGroup

    安全组对象

    被如下接口引用:CloneSecurityGroup, CreateDefaultSecurityGroup, CreateSecurityGroup, CreateSecurityGroupWithPolicies, DescribeSecurityGroups。

    名称 类型 必选 描述
    SecurityGroupId String 安全组实例ID,例如:sg-ohuuioma。
    示例值:sg-05bb4upy
    SecurityGroupName String 安全组名称,可任意命名,但不得超过60个字符。
    示例值:TestGroup
    SecurityGroupDesc String 安全组备注,最多100个字符。
    示例值:test-group-desc
    ProjectId String 项目id,默认0。可在qcloud控制台项目管理页面查询到。
    示例值:0
    IsDefault Boolean 是否是默认安全组,默认安全组不支持删除。
    示例值:false
    CreatedTime String 安全组创建时间。
    示例值:2017-04-18 21:02:30
    TagSet Array of Tag 标签键值对。
    示例值:[{"Key": "Version", "Value": "TEST"}]
    UpdateTime String 安全组更新时间。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2017-04-18 21:02:30

    SecurityGroupAssociationStatistics

    安全组关联的实例统计

    被如下接口引用:DescribeSecurityGroupAssociationStatistics。

    名称 类型 描述
    SecurityGroupId String 安全组实例ID。
    示例值:sg-kngiybxl
    CVM Integer 云服务器实例数。
    示例值:10
    CDB Integer MySQL数据库实例数。
    示例值:2
    ENI Integer 弹性网卡实例数。
    示例值:12
    SG Integer 被安全组引用数。
    示例值:2
    CLB Integer 负载均衡实例数。
    示例值:3
    InstanceStatistics Array of InstanceStatistic 全量实例的绑定统计。
    示例值:[{"InstanceType": "CVM", "InstanceCount": 10}]
    TotalCount Integer 所有资源的总计数(不包含被安全组引用数)。
    示例值:50

    SecurityGroupLimitSet

    用户安全组配额限制。

    被如下接口引用:DescribeSecurityGroupLimits。

    名称 类型 描述
    SecurityGroupLimit Integer 每个项目每个地域可创建安全组数
    示例值:50
    SecurityGroupPolicyLimit Integer 安全组下的最大规则数
    示例值:100
    ReferedSecurityGroupLimit Integer 安全组下嵌套安全组规则数
    示例值:10
    SecurityGroupInstanceLimit Integer 单安全组关联实例数
    示例值:2000
    InstanceSecurityGroupLimit Integer 实例关联安全组数
    示例值:5
    SecurityGroupExtendedPolicyLimit Integer 安全组展开后的规则数限制
    示例值:30000
    SecurityGroupReferedCvmAndEniLimit Integer 被引用的安全组关联CVM、ENI的实例配额
    示例值:2000
    SecurityGroupReferedSvcLimit Integer 被引用的安全组关联数据库、LB等服务实例配额
    示例值:2000

    SecurityGroupPolicy

    安全组规则对象

    被如下接口引用:CreateSecurityGroupPolicies, CreateSecurityGroupWithPolicies, DeleteSecurityGroupPolicies, DescribeSecurityGroupPolicies, DescribeSgSnapshotFileContent, ModifySecurityGroupPolicies, ReplaceSecurityGroupPolicies, ReplaceSecurityGroupPolicy。

    名称 类型 必选 描述
    PolicyIndex Integer 安全组规则索引号,值会随着安全组规则的变更动态变化。使用PolicyIndex时,请先调用DescribeSecurityGroupPolicies获取到规则的PolicyIndex,并且结合返回值中的Version一起使用处理规则。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    Protocol String 协议, 取值: TCP,UDP,ICMP,ICMPv6,ALL。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:TCP
    Port String 端口(all, 离散port, range)。
    说明:如果Protocol设置为ALL,则Port也需要设置为all。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:22
    ServiceTemplate ServiceTemplateSpecification 协议端口ID或者协议端口组ID。ServiceTemplate和Protocol+Port互斥。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:ppm-8g7k5qfq
    CidrBlock String 网段或IP(互斥),特殊说明:0.0.0.0/n 都会映射为0.0.0.0/0。作为入参时,可使用字符串MY_PUBLIC_IP指代发起请求的公网IP地址。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:10.0.0.0/16
    Ipv6CidrBlock String 网段或IPv6(互斥)。作为入参时,可使用字符串MY_PUBLIC_IP指代发起请求的公网IPv6地址。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:::/0
    SecurityGroupId String 安全组实例ID,例如:sg-ohuuioma。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:sg-ohuuioma
    AddressTemplate AddressTemplateSpecification IP地址ID或者IP地址组ID。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:ipm-p5sf61yj
    Action String ACCEPT 或 DROP。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:ACCEPT
    PolicyDescription String 安全组规则描述。作为入参时,当未传递该参数或值为空,且参数CidrBlock或Ipv6CidrBlock值为MY_PUBLIC_IP时,该参数的值将会被自动填充为Replaced-From-MY_PUBLIC_IP。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:demo
    ModifyTime String 安全组最近修改时间。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2021-03-02 14:41:15

    SecurityGroupPolicySet

    安全组规则集合

    被如下接口引用:CreateSecurityGroupPolicies, CreateSecurityGroupWithPolicies, DeleteSecurityGroupPolicies, DescribeSecurityGroupPolicies, ModifySecurityGroupPolicies, ReplaceSecurityGroupPolicies, ReplaceSecurityGroupPolicy。

    名称 类型 必选 描述
    Version String 安全组规则当前版本。用户每次更新安全规则版本会自动加1,防止更新的路由规则已过期,不填不考虑冲突。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:10
    Egress Array of SecurityGroupPolicy 出站规则。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[]
    Ingress Array of SecurityGroupPolicy 入站规则。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[{'PolicyIndex': 0, 'Port': '443', 'CidrBlock': '0.0.0.0/0', 'Ipv6CidrBlock': '', 'SecurityGroupId': '', 'Action': 'ACCEPT', 'ModifyTime': '2020-10-09 10:00:00', 'PolicyDescription': '', 'Protocol': 'tcp', 'ServiceTemplate': {'ServiceId': '', 'ServiceGroupId': ''}, 'AddressTemplate': {'AddressId': '', 'AddressGroupId': ''}, 'Diff': False}]
    PolicyStatistics PolicyStatistics 安全组策略条目统计。只用于出参。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[]

    SecurityPolicyDatabase

    SecurityPolicyDatabase策略

    被如下接口引用:CreateVpnConnection, DescribeVpnConnections, ModifyVpnConnectionAttribute。

    名称 类型 必选 描述
    LocalCidrBlock String 本端网段
    示例值:10.40.1.12/24
    RemoteCidrBlock Array of String 对端网段
    示例值:['172.123.10.5/16', '10.7.10.0/16']

    ServiceTemplate

    协议端口模板

    被如下接口引用:CreateServiceTemplate, CreateServiceTemplateGroup, DescribeServiceTemplateGroups, DescribeServiceTemplates。

    名称 类型 描述
    ServiceTemplateId String 协议端口实例ID,例如:ppm-f5n1f8da。
    示例值:ppm-f5n1f8da
    ServiceTemplateName String 模板名称。
    示例值:demo
    ServiceSet Array of String 协议端口信息。
    示例值:["tcp:80"]
    CreatedTime String 创建时间。
    示例值:2021-03-02 14:41:15
    UpdatedTime String 最后更新时间。
    示例值:2021-03-02 14:41:15
    ServiceExtraSet Array of ServicesInfo 带备注的协议端口信息。
    示例值:[{"Service": "tcp:80", "Description": "web service"}]
    TagSet Array of Tag 标签键值对。
    示例值:[{"Key": "env", "Value": "prod"}]

    ServiceTemplateGroup

    协议端口模板集合

    被如下接口引用:CreateServiceTemplateGroup, DescribeServiceTemplateGroups。

    名称 类型 描述
    ServiceTemplateGroupId String 协议端口模板集合实例ID,例如:ppmg-2klmrefu。
    示例值:ppmg-2klmrefu
    ServiceTemplateGroupName String 协议端口模板集合名称。
    示例值:demo
    ServiceTemplateIdSet Array of String 协议端口模板实例ID。
    示例值:["ppm-f5n1f8da"]
    CreatedTime String 创建时间。
    示例值:2021-03-02 14:41:15
    UpdatedTime String 最后更新时间。
    示例值:2021-03-02 14:41:15
    ServiceTemplateSet Array of ServiceTemplate 协议端口模板实例信息。
    示例值:[{"ServiceTemplateId": "ppm-f5n1f8da", "ServiceTemplateName": "demo", "ServiceSet": ["tcp:80"], "CreatedTime": "2021-03-02 14:41:15", "ServiceExtraSet": [{"Service": "tcp:80", "Description": "web service"}]}]
    TagSet Array of Tag 标签键值对。
    示例值:[{"Key": "env", "Value": "prod"}]

    ServiceTemplateSpecification

    协议端口模板

    被如下接口引用:CreateSecurityGroupPolicies, CreateSecurityGroupWithPolicies, DeleteSecurityGroupPolicies, DescribeSecurityGroupPolicies, DescribeSgSnapshotFileContent, ModifySecurityGroupPolicies, ReplaceSecurityGroupPolicies, ReplaceSecurityGroupPolicy。

    名称 类型 必选 描述
    ServiceId String 协议端口ID,例如:ppm-f5n1f8da。
    示例值:ppm-f5n1f8da
    ServiceGroupId String 协议端口组ID,例如:ppmg-f5n1f8da。
    示例值:ppmg-f5n1f8da

    ServicesInfo

    协议端口模板信息

    被如下接口引用:CreateServiceTemplate, CreateServiceTemplateGroup, DescribeServiceTemplateGroups, DescribeServiceTemplates, ModifyServiceTemplateAttribute。

    名称 类型 必选 描述
    Service String 协议端口。
    示例值:tcp:80
    Description String 备注。
    示例值:desc
    UpdatedTime String 更新时间。
    示例值:2020-08-10 18:10:12

    SnapshotFileInfo

    快照文件信息

    被如下接口引用:DescribeSnapshotFiles。

    名称 类型 描述
    SnapshotPolicyId String 快照策略Id。
    示例值:sspolicy-hx8an9sr
    InstanceId String 实例Id。
    示例值:sg-qwmk1q
    SnapshotFileId String 快照文件Id。
    示例值:ssfile-rnhdyl67
    BackupTime String 备份时间。
    示例值:2021-03-02 14:41:15
    Operator String 操作者Uin。
    示例值:123445567

    SnapshotInstance

    快照策略关联实例信息

    被如下接口引用:AttachSnapshotInstances, DescribeSnapshotAttachedInstances, DetachSnapshotInstances。

    名称 类型 必选 描述
    InstanceId String 实例Id。
    示例值:sg-123zsda
    InstanceType String 实例类型,目前支持安全组:securitygroup。
    示例值:securitygroup
    InstanceRegion String 实例所在地域。
    示例值:ap-guangzhou
    SnapshotPolicyId String 快照策略Id。
    示例值:sspolicy-hx8an9sr
    InstanceName String 实例名称。
    示例值:名称

    SnapshotPolicy

    快照策略

    被如下接口引用:CreateSnapshotPolicies, DescribeSnapshotPolicies。

    名称 类型 必选 描述
    SnapshotPolicyName String 快照策略名称。
    示例值:demo
    BackupType String 备份策略类型,operate-操作备份,time-定时备份。
    示例值:time
    KeepTime Integer 保留时间,支持1~365天。
    示例值:12
    CreateNewCos Boolean 是否创建新的cos桶,默认为False。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:true
    CosRegion String cos桶所在地域。
    示例值:ap-guangzhou
    CosBucket String cos桶。
    示例值:cos-nswq8wkq
    SnapshotPolicyId String 快照策略Id。
    示例值:sspolicy-hx8an9sr
    BackupPolicies Array of BackupPolicy 时间备份策略。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[]
    Enable Boolean 启用状态,True-启用,False-停用,默认为True。
    示例值:true
    CreateTime String 创建时间。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2021-03-02 14:41:15
    TagSet Array of Tag 标签键值对。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[]

    SourceIpTranslationNatRule

    NAT的SNAT规则

    被如下接口引用:CreateNatGateway, CreateNatGatewaySourceIpTranslationNatRule, DescribeNatGatewaySourceIpTranslationNatRules, DescribeNatGateways, ModifyNatGatewaySourceIpTranslationNatRule。

    名称 类型 必选 描述
    ResourceId String 资源ID,如果ResourceType为USERDEFINED,可以为空字符串
    示例值:subnet-7aed90al
    ResourceType String 资源类型,目前包含SUBNET、NETWORKINTERFACE、USERDEFINED
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:SUBNET
    PrivateIpAddress String 源IP/网段
    示例值:172.168.100.0/24
    PublicIpAddresses Array of String 弹性IP地址池
    示例值:['180.12.59.43']
    Description String 规则描述
    示例值:production subnet
    NatGatewaySnatId String Snat规则ID
    示例值:snat-3nptcfvp
    NatGatewayId String NAT网关的ID。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:nat-3nptcfvp
    VpcId String 私有网络VPC的ID。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:vpc-oty76xyl
    CreatedTime String NAT网关SNAT规则创建时间。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2021-03-14 13:59:00

    SslClientConfig

    DownloadVpnGatewaySslClientCert 使用

    被如下接口引用:DownloadVpnGatewaySslClientCert。

    名称 类型 描述
    SslVpnClientConfiguration String 客户端配置
    示例值:----config----
    SslVpnRootCert String 更证书
    示例值:-----BEGIN CERTIFICATE-----END CERTIFICATE-----
    SslVpnKey String 客户端密钥
    示例值:-----BEGIN PRIVATE KEY-----END PRIVATE KEY-----
    SslVpnCert String 客户端证书
    示例值:-----BEGIN CERTIFICATE-----END CERTIFICATE-----
    SslVpnClientId String SSL-VPN-CLIENT 实例ID。
    示例值:vpnc-nfvtjf3k

    SslVpnClient

    SSL-VPN-CLIENT 出参

    被如下接口引用:DescribeVpnGatewaySslClients。

    名称 类型 描述
    VpcId String VPC实例ID。
    示例值:vpc-123456
    SslVpnServerId String SSL-VPN-SERVER 实例ID。
    示例值:vpns-xaw12xae
    CertStatus Integer 证书状态。
    0:创建中
    1:正常
    2:已停用
    3.已过期
    4.创建出错
    示例值:0
    SslVpnClientId String SSL-VPN-CLIENT 实例ID。
    示例值:vpngwSslClient-123456
    CertBeginTime String 证书开始时间。
    示例值:2021-01-01 00:00:00
    CertEndTime String 证书到期时间。
    示例值:2021-01-01 00:00:00
    Name String CLIENT NAME。
    示例值:name-test
    State String 创建CLIENT 状态。
    0 创建中
    1 创建出错
    2 更新中
    3 更新出错
    4 销毁中
    5 销毁出错
    6 已连通
    7 未知
    示例值:0

    SslVpnSever

    SSL-VPN-SERVER 出参

    被如下接口引用:DescribeVpnGatewaySslServers。

    名称 类型 描述
    VpcId String VPC实例ID.
    示例值:vpc-123456
    SslVpnServerId String SSL-VPN-SERVER 实例ID。
    示例值:vpngwSslServer-123456
    VpnGatewayId String VPN 实例ID。
    示例值:vpngw-123456
    SslVpnServerName String SSL-VPN-SERVER name。
    示例值:server name
    LocalAddress Array of String 本端地址段。
    示例值:["10.0.0.0/16"]
    RemoteAddress String 客户端地址段。
    示例值:172.16.0.0/16
    MaxConnection Integer 客户端最大连接数。
    示例值:5
    WanIp String SSL-VPN 网关公网IP。
    示例值:100.0.0.1
    SslVpnProtocol String SSL VPN服务端监听协议
    示例值:UDP
    SslVpnPort Integer SSL VPN服务端监听协议端口
    示例值:1194
    EncryptAlgorithm String 加密算法。
    示例值:AES-128
    IntegrityAlgorithm String 认证算法。
    示例值:SHA1
    Compress Integer 是否支持压缩。
    示例值:False
    CreateTime String 创建时间。
    示例值:2021-01-01 00:00:00
    State Integer SSL-VPN-SERVER 创建状态。
    0 创建中
    1 创建出错
    2 更新中
    3 更新出错
    4 销毁中
    5 销毁出错
    6 已连通
    7 未知
    示例值:6
    SsoEnabled Integer 是否开启SSO认证。1:开启 0: 不开启
    示例值:0
    EiamApplicationId String EIAM应用ID
    示例值:applicationId
    AccessPolicyEnabled Integer 是否开启策略控制。0:不开启 1: 开启
    示例值:0
    AccessPolicy Array of AccessPolicy 策略信息
    示例值:{'TargetCidr': '10.0.8.0/24','UserGroupIds': ['user-123'],'ForAllClient': 0,'Remark': 'test-01'}
    SpName String CAM服务提供商Name
    示例值:sp-name-01

    Subnet

    子网对象

    被如下接口引用:CreateAssistantCidr, CreateNetworkAcl, CreateSubnet, CreateSubnets, CreateVpc, DescribeAssistantCidr, DescribeNetworkAcls, DescribeSubnets, DescribeVpcs, ModifyAssistantCidr。

    名称 类型 描述
    VpcId String VPC实例ID
    示例值:vpc-5k6fot41
    SubnetId String 子网实例ID,例如:subnet-bthucmmy。
    示例值:subnet-kgpu7qt2
    SubnetName String 子网名称。
    示例值:demo
    CidrBlock String 子网的 IPv4 CIDR
    示例值:10.0.0.0/24
    IsDefault Boolean 是否默认子网。
    示例值:false
    EnableBroadcast Boolean 是否开启广播。
    示例值:false
    Zone String 可用区。
    示例值:ap-guangzhou-1
    RouteTableId String 路由表实例ID,例如:rtb-l2h8d7c2。
    示例值:rtb-7t9oijd0
    CreatedTime String 创建时间。
    示例值:2023-03-21 18:00:00
    AvailableIpAddressCount Integer 可用IPv4数。
    示例值:253
    Ipv6CidrBlock String 子网的 IPv6 CIDR
    示例值:
    NetworkAclId String 关联ACLID
    示例值:acl-g1ogd8r2
    IsRemoteVpcSnat Boolean 是否为 SNAT 地址池子网。
    示例值:false
    TotalIpAddressCount Integer 子网IPv4总数。
    示例值:256
    TagSet Array of Tag 标签键值对。
    示例值:[]
    CdcId String CDC实例ID。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:cluster-gbo27yc4
    IsCdcSubnet Integer 是否是CDC所属子网。0:否 1:是
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0

    SubnetInput

    子网对象

    被如下接口引用:CreateSubnets。

    名称 类型 必选 描述
    CidrBlock String 子网的CIDR
    示例值:10.0.0.0/24
    SubnetName String 子网名称。
    示例值:demo
    Zone String 可用区。形如:ap-guangzhou-2
    示例值:ap-guangzhou-2
    RouteTableId String 指定关联路由表,形如:rtb-3ryrwzuu
    示例值:rtb-h0fk8lfc

    Tag

    标签键值对

    被如下接口引用:AllocateAddresses, AllocateIPv6Addresses, AllocateIp6AddressesBandwidth, CloneSecurityGroup, CreateAddressTemplate, CreateAddressTemplateGroup, CreateAndAttachNetworkInterface, CreateAssistantCidr, CreateBandwidthPackage, CreateCcn, CreateCustomerGateway, CreateDefaultSecurityGroup, CreateDhcpIp, CreateDirectConnectGateway, CreateFlowLog, CreateHaVip, CreateHighPriorityRouteTable, CreateLocalGateway, CreateNatGateway, CreateNetDetect, CreateNetworkAcl, CreateNetworkInterface, CreatePrivateNatGateway, CreateReserveIpAddresses, CreateRouteTable, CreateRoutes, CreateSecurityGroup, CreateSecurityGroupWithPolicies, CreateServiceTemplate, CreateServiceTemplateGroup, CreateSnapshotPolicies, CreateSubnet, CreateSubnets, CreateTrafficMirror, CreateVpc, CreateVpcEndPoint, CreateVpcEndPointService, CreateVpnConnection, CreateVpnGateway, CreateVpnGatewaySslClient, CreateVpnGatewaySslServer, DescribeAddressTemplateGroups, DescribeAddressTemplates, DescribeAddresses, DescribeAssistantCidr, DescribeCcns, DescribeDhcpIps, DescribeFlowLog, DescribeFlowLogs, DescribeHaVips, DescribeIPv6Addresses, DescribeIp6Addresses, DescribeLocalGateway, DescribeNatGateways, DescribeNetDetects, DescribeNetworkAcls, DescribeNetworkInterfaces, DescribePrivateNatGateways, DescribeReserveIpAddresses, DescribeRouteTables, DescribeSecurityGroups, DescribeServiceTemplateGroups, DescribeServiceTemplates, DescribeSnapshotPolicies, DescribeSubnets, DescribeTrafficPackages, DescribeVpcEndPoint, DescribeVpcEndPointService, DescribeVpcPeeringConnections, DescribeVpcs, DescribeVpnConnections, GetCcnRegionBandwidthLimits, ModifyAssistantCidr。

    名称 类型 必选 描述
    Key String 标签键
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:tag-key
    Value String 标签值
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:tag-value

    Tags

    标签描述信息

    被如下接口引用:CreateVpcPeeringConnection。

    名称 类型 必选 描述
    Key String 标签键
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:tag-key
    Value String 标签值
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:tag-value

    TemplateLimit

    参数模板配额

    被如下接口引用:DescribeTemplateLimits。

    名称 类型 描述
    AddressTemplateMemberLimit Integer 参数模板IP地址成员配额。
    示例值:20
    AddressTemplateGroupMemberLimit Integer 参数模板IP地址组成员配额。
    示例值:10
    ServiceTemplateMemberLimit Integer 参数模板I协议端口成员配额。
    示例值:20
    ServiceTemplateGroupMemberLimit Integer 参数模板协议端口组成员配额。
    示例值:10

    TrafficFlow

    流量描述。

    被如下接口引用:DescribeSpecificTrafficPackageUsedDetails。

    名称 类型 描述
    Value Integer 实际流量,单位为 字节
    示例值:10737418240
    FormatValue Float 格式化后的流量,单位见参数 FormatUnit
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:10.0
    FormatUnit String 格式化后流量的单位
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:GB

    TrafficMirror

    流量镜像实例

    被如下接口引用:CreateTrafficMirror, DescribeTrafficMirrors。

    名称 类型 描述
    VpcId String VPC实例ID。
    示例值:vpc-7zayowkt
    TrafficMirrorId String 流量镜像实例。
    示例值:imgf-oc2mpbni
    TrafficMirrorName String 流量镜像名字。
    示例值:demo
    TrafficMirrorDescribe String 流量镜像描述。
    示例值:demo
    State String 流量镜像状态。
    示例值:RUNNING
    Direction String 流量镜像采集方向。
    示例值:ALL
    CollectorSrcs Array of String 流量镜像采集对象。
    示例值:["vpc-7zayowkt"]
    NatId String 流量镜像过滤的nat网关实例ID。
    示例值:nat-qo7kugz0
    CollectorNormalFilters Array of TrafficMirrorFilter 流量镜像过滤的五元组规则。
    CollectorTarget TrafficMirrorTarget 流量镜接收目标。
    CreateTime String 流量镜像创建时间。
    示例值:2021-03-02 14:41:15
    Type String 流量镜像的类型。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:VPC
    SubnetId String 流量镜像所属的子网ID。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:subnet-6zwa44xm
    TargetInfo Array of TrafficMirrorTargetResourceInfo 流量镜接收目标资源信息,当接收目标为ENI和CLB时返回。
    注意:此字段可能返回 null,表示取不到有效值。

    TrafficMirrorFilter

    流量镜像五元组过滤规则对象

    被如下接口引用:CreateTrafficMirror, DescribeTrafficMirrors, ResetTrafficMirrorFilter, UpdateTrafficMirrorAllFilter。

    名称 类型 必选 描述
    SrcNet String 过滤规则的源网段
    示例值:10.0.0.0/24
    DstNet String 过滤规则的目的网段
    示例值:192.168.0.0/24
    Protocol String 过滤规则的协议
    示例值:ALL
    SrcPort String 过滤规则的源端口,默认值1-65535
    示例值:5000
    DstPort String 过滤规则的目的端口,默认值1-65535
    示例值:3456

    TrafficMirrorTarget

    流量镜像采集目标类型

    被如下接口引用:CheckTrafficMirror, CreateTrafficMirror, DescribeTrafficMirrors, ResetTrafficMirrorTarget。

    名称 类型 必选 描述
    TargetIps Array of String 流量镜像的接收IP
    示例值:["10.0.0.0"]
    AlgHash String 流量镜像接收IP组,均衡规则,支持ENI/FIVE_TUPLE_FLOW(vpc),FIVE_TUPLE_FLOW(公网IP)
    示例值:FIVE_TUPLE_FLOW
    TargetEndPoints Array of String 流量镜像的接收endpoint(公网IP)
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:10.0.0.0
    TargetType String 流量镜像的接收类型,分别为:IP/ENI/CLB
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:IP

    TrafficMirrorTargetResourceInfo

    流量镜像接收流量信息,当接收目标为ENI和CLB时返回

    被如下接口引用:CreateTrafficMirror, DescribeTrafficMirrors。

    名称 类型 描述
    TargetId String 接收目标的资源Id
    示例值:eni-kiaim12s
    TargetName String 接收目标的资源名称
    示例值:name

    TrafficPackage

    流量包信息描述类型

    被如下接口引用:DescribeTrafficPackages。

    名称 类型 描述
    TrafficPackageId String 流量包唯一ID
    示例值:tfp-yj123h6i
    TrafficPackageName String 流量包名称
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:未命名
    TotalAmount Float 流量包总量,单位GB
    示例值:10.0
    RemainingAmount Float 流量包剩余量,单位GB
    示例值:10.0
    Status String 流量包状态,可能的值有: AVAILABLE-可用状态, EXPIRED-已过期, EXHAUSTED-已用完, REFUNDED-已退还, DELETED-已删除
    示例值:AVAILABLE
    CreatedTime Timestamp ISO8601 流量包创建时间
    示例值:2022-08-31T11:42:37Z
    Deadline Timestamp ISO8601 流量包截止时间
    示例值:2022-09-30T11:42:36Z
    UsedAmount Float 已使用的流量,单位GB
    示例值:0.0
    TagSet Array of Tag 流量包标签
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[]
    DeductType String 区分闲时流量包与全时流量包
    示例值:FULL_TIME

    TrafficQosPolicySet

    流量调度规则

    被如下接口引用:DescribeTrafficQosPolicy。

    名称 类型 必选 描述
    CcnId String CCN实例ID。形如:ccn-f49l6u0z。
    示例值:ccn-gjug0kul
    QosId Integer qos id。
    示例值:1
    QosPolicyDescription String 描述。
    示例值:qos-desc
    QosPolicyName String 名称。
    示例值:qos-name
    Bandwidth Integer 带宽。
    示例值:1
    QosPolicyId String 流量调度策略ID。
    示例值:qos-n4i5plee

    TranslationAclRule

    私网网关转发规则匹配ACL

    被如下接口引用:CreatePrivateNatGatewayTranslationAclRule, DescribePrivateNatGatewayTranslationAclRules, ModifyPrivateNatGatewayTranslationAclRule。

    名称 类型 必选 描述
    Protocol String ACL协议类型,可选值:"ALL","TCP","UDP"
    示例值:"ALL"
    SourcePort String 源端口。
    示例值:"80"
    SourceCidr String 源地址。支持ipcidr格式"xxx.xxx.xxx.000/xx"
    示例值:"127.0.0.1"
    DestinationPort String 目的端口。
    示例值:"8081"
    DestinationCidr String 目的地址。
    示例值:"100.0.20.3"
    AclRuleId Integer ACL规则ID
    示例值:1
    Action Integer 是否匹配。
    示例值:0
    Description String ACL规则描述
    示例值:"ACL规则描述"

    TranslationNatRule

    私网网关Snat转发规则

    被如下接口引用:DeletePrivateNatGatewayTranslationNatRule, DescribePrivateNatGatewayTranslationNatRules。

    名称 类型 必选 描述
    TranslationDirection String 转换规则目标,可选值"LOCAL","PEER"。
    示例值:"LOCAL"
    TranslationType String 转换规则类型,可选值"NETWORK_LAYER","TRANSPORT_LAYER"。
    示例值:"NETWORK_LAYER"
    TranslationIp String 转换IP,当转换规则类型为四层时为IP池。
    示例值:"10.0.13.21"
    Description String 转换规则描述。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:my service
    OriginalIp String IP,当转换规则类型为三层时有效。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:"10.0.13.20"
    CreateTime String 创建时间。
    示例值:"2022-09-29 15:58:00"
    UpdateTime String 更新时间。
    示例值:"2022-09-29 15:58:00"

    TranslationNatRuleDiff

    私网网关Snat转发规则修改

    被如下接口引用:ModifyPrivateNatGatewayTranslationNatRule。

    名称 类型 必选 描述
    TranslationDirection String 转发规则目标,可选值"LOCAL","PEER"。
    示例值:"LOCAL"
    TranslationType String 转发规则类型,可选值"NETWORK_LAYER","TRANSPORT_LAYER"。
    示例值:"NETWORK_LAYER"
    TranslationIp String 转发规则映射IP,当转发规则类型为四层时为IP
    示例值:"10.0.13.21"
    Description String 转发规则描述。
    示例值:my service
    OldTranslationIp String 旧转发规则映射IP,当转发规则类型为四层时为IP
    示例值:"10.0.13.21"
    OriginalIp String 新转发规则源IP,当转发规则类型为三层时有效
    示例值:"10.0.13.20"
    OldOriginalIp String 旧转发规则源IP,当转发规则类型为三层时有效
    示例值:"10.0.13.19"

    TranslationNatRuleInput

    私网网关Snat转发规则入参

    被如下接口引用:CreatePrivateNatGatewayTranslationNatRule。

    名称 类型 必选 描述
    TranslationDirection String 转换规则目标,可选值"LOCAL","PEER"。
    示例值:"LOCAL"
    TranslationType String 转换规则类型,可选值"NETWORK_LAYER","TRANSPORT_LAYER"。
    示例值:"NETWORK_LAYER"
    TranslationIp String 转换IP,当转换规则类型为四层时为IP池。
    示例值:"10.0.13.21"
    Description String 转换规则描述。
    示例值:my service
    OriginalIp String IP,当转换规则类型为三层时有效。
    示例值:"10.0.13.20"

    UsedDetail

    共享流量包用量明细

    被如下接口引用:DescribeSpecificTrafficPackageUsedDetails。

    名称 类型 描述
    TrafficPackageId String 流量包唯一ID
    示例值:tfp-jhkxmr9n
    TrafficPackageName String 流量包名称
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:demo
    TotalAmount TrafficFlow 流量包总量
    Deduction TrafficFlow 本次抵扣
    RemainingAmount TrafficFlow 本次抵扣后剩余量
    Time Timestamp 抵扣时间
    示例值:2024-01-01 01:00
    ResourceType String 资源类型。可能的值: CVM, LB, NAT, HAVIP, EIP
    示例值:EIP
    ResourceId String 资源ID
    示例值:eip-orijzef8
    ResourceName String 资源名称
    示例值:demo
    Deadline Timestamp 流量包到期时间
    示例值:2024-12-01 13:51:17

    Vpc

    私有网络(VPC)对象。

    被如下接口引用:CreateVpc, DescribeVpcs。

    名称 类型 描述
    VpcName String VPC名称。
    示例值:demo
    VpcId String VPC实例ID,例如:vpc-azd4dt1c。
    示例值: vpc-azd4dt1c
    CidrBlock String VPCIPv4 CIDR
    示例值:10.0.0.0/16
    IsDefault Boolean 是否默认VPC
    示例值: true
    EnableMulticast Boolean 是否开启组播。
    示例值:true
    CreatedTime String 创建时间。
    示例值: 2021-01-03 22:25:45
    DnsServerSet Array of String DNS列表。
    示例值:["8.8.8.8"]
    DomainName String DHCP域名选项值。
    示例值: demo
    DhcpOptionsId String DHCP选项集ID
    示例值:dopt-8g7k5qfq
    EnableDhcp Boolean 是否开启DHCP
    示例值: false
    Ipv6CidrBlock String VPCIPv6 CIDR
    示例值:3402:4e00:20:1200::/56
    TagSet Array of Tag 标签键值对
    示例值:[]
    AssistantCidrSet Array of AssistantCidr 辅助CIDR
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[]

    VpcEndPointServiceUser

    终端节点服务的服务白名单对象详情。

    被如下接口引用:DescribeVpcEndPointServiceWhiteList。

    名称 类型 描述
    Owner Integer AppId。
    示例值:1254277469
    UserUin String Uin。
    示例值:700000483554
    Description String 描述信息。
    示例值:demo
    CreateTime String 创建时间。
    示例值:2021-01-14 15:58:40
    EndPointServiceId String 终端节点服务ID。
    示例值:vpcsvc-b2mrmmx7

    VpcIpv6Address

    VPC内网IPv6对象。

    被如下接口引用:DescribeVpcIpv6Addresses。

    名称 类型 描述
    Ipv6Address String VPCIPv6地址。
    示例值:240d:a000:1058:7d04:0:2d73:9ea3:70a4
    CidrBlock String 所属子网 IPv6 CIDR
    示例值:240d:a000:1058:7d04::/64
    Ipv6AddressType String IPv6类型。
    示例值:ENI
    CreatedTime String IPv6申请时间。
    示例值:2020-06-08 10:00:00

    VpcLimit

    私有网络配额

    被如下接口引用:DescribeVpcLimits。

    名称 类型 描述
    LimitType String 私有网络配额描述
    示例值:vpc-max-enis
    LimitValue Integer 私有网络配额值
    示例值:1000

    VpcPrivateIpAddress

    VPC内网IP对象。

    被如下接口引用:DescribeVpcPrivateIpAddresses。

    名称 类型 描述
    PrivateIpAddress String VPC内网IP
    示例值:10.0.0.10
    CidrBlock String 所属子网CIDR
    示例值:10.0.0.0/24
    PrivateIpAddressType String 内网IP类型。
    示例值:ENI
    CreatedTime Timestamp IP申请时间。
    示例值:2020-06-06 10:00:00

    VpcTaskResultDetailInfo

    Vpc任务结果详细信息。

    被如下接口引用:DescribeVpcTaskResult。

    名称 类型 描述
    ResourceId String 资源ID。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:eni-olifj433
    Status String 状态。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:SUCCESS

    VpnConnection

    VPN通道对象。

    被如下接口引用:CreateVpnConnection, DescribeVpnConnections。

    名称 类型 描述
    VpnConnectionId String 通道实例ID。
    示例值:vpnx-xxxxx
    VpnConnectionName String 通道名称。
    示例值:vpn-con-01
    VpcId String VPC实例ID。
    示例值:vpc-xxxxx
    VpnGatewayId String VPN网关实例ID。
    示例值:vpngw-xxxxx
    CustomerGatewayId String 对端网关实例ID。
    示例值:cgw-xxxxx
    PreShareKey String 预共享密钥。
    示例值:erxw1o931
    VpnProto String 通道传输协议。
    示例值:IPSEC
    EncryptProto String 通道加密协议。
    示例值:IKE
    RouteType String 路由类型。
    示例值:StaticRoute
    CreatedTime Timestamp 创建时间。
    示例值:0000-00-00 00:00:00
    State String 通道的生产状态,PENDING:生产中,AVAILABLE:运行中,DELETING:删除中。
    示例值:AVAILABLE
    NetStatus String 通道连接状态,AVAILABLE:已连接。
    示例值:AVAILABLE
    SecurityPolicyDatabaseSet Array of SecurityPolicyDatabase SPD。
    示例值:[{"localCidrBlock": "0.0.0.0/0", "remoteCidrBlock": ["0.0.0.0/0"]}]
    IKEOptionsSpecification IKEOptionsSpecification IKE选项。
    IPSECOptionsSpecification IPSECOptionsSpecification IPSEC选择。
    EnableHealthCheck Boolean 是否支持健康状态探测
    示例值:false
    HealthCheckLocalIp String 本端探测ip
    示例值:0.0.0.0
    HealthCheckRemoteIp String 对端探测ip
    示例值:0.0.0.0
    HealthCheckStatus String 通道健康检查状态,AVAILABLE:正常,UNAVAILABLE:不正常。 未配置健康检查不返回该对象
    示例值:AVAILABLE
    DpdEnable Integer DPD探测开关。默认为0,表示关闭DPD探测。可选值:0(关闭),1(开启)
    示例值:0
    DpdTimeout String DPD超时时间。即探测确认对端不存在需要的时间。
    示例值:30
    DpdAction String DPD超时后的动作。默认为clear。dpdEnable为1(开启)时有效。可取值为clear(断开)和restart(重试)
    示例值:clear
    TagSet Array of Tag 标签键值对数组
    示例值:[{'Key': 'tag-key', 'Value': 'tag-value'}]
    NegotiationType String 协商类型
    示例值:flowTrigger
    BgpConfig BgpConfigAndAsn Bgp配置信息
    HealthCheckConfig HealthCheckConfig Nqa配置信息
    示例值:{"ProbeInterval": "5000", "ProbeThreshold": "3", "ProbeTimeout": "150", "ProbeType": "NQA"}

    VpnGateway

    VPN网关对象。

    被如下接口引用:CreateVpnGateway, DescribeVpnGateways。

    名称 类型 描述
    VpnGatewayId String 网关实例ID。
    示例值:vpngw-az2xuzp5
    VpcId String VPC实例ID。
    示例值:vpc-qqa5rnd5
    VpnGatewayName String 网关实例名称。
    示例值:test-gateway
    Type String 网关实例类型:'IPSEC', 'SSL','CCN','SSL_CCN'。
    示例值:IPSEC
    State String 网关实例状态, 'PENDING':生产中,'PENDING_ERROR':生产失败,'DELETING':删除中,'DELETING_ERROR':删除失败,'AVAILABLE':运行中。
    示例值:AVAILABLE
    PublicIpAddress String 网关公网IP。
    示例值:139.124.3.2
    RenewFlag String 网关续费类型:'NOTIFY_AND_MANUAL_RENEW':手动续费,'NOTIFY_AND_AUTO_RENEW':自动续费,'NOT_NOTIFY_AND_NOT_RENEW':到期不续费。
    示例值:NOTIFY_AND_MANUAL_RENEW
    InstanceChargeType String 网关付费类型:POSTPAID_BY_HOUR:按量计费,PREPAID:包年包月预付费。
    示例值:POSTPAID_BY_HOUR
    InternetMaxBandwidthOut Integer 网关出带宽。
    示例值:5
    CreatedTime Timestamp 创建时间。
    示例值:2021-04-25 17:14:34
    ExpiredTime Timestamp 预付费网关过期时间。
    示例值:2021-04-25 17:14:34
    IsAddressBlocked Boolean 公网IP是否被封堵。
    示例值:false
    NewPurchasePlan String 计费模式变更,PREPAID_TO_POSTPAID:包年包月预付费到期转按小时后付费。
    示例值:PREPAID_TO_POSTPAID
    RestrictState String 网关计费状态,PROTECTIVELY_ISOLATED:被安全隔离的实例,NORMAL:正常。
    示例值:PROTECTIVELY_ISOLATED
    Zone String 可用区,如:ap-guangzhou-2。
    示例值:ap-guangzhou-2
    VpnGatewayQuotaSet Array of VpnGatewayQuota 网关带宽配额信息。
    示例值:[{'Bandwidth': 5, 'Cname': '微小型', 'Name': 'cdmini'}, {'Bandwidth': 10, 'Cname': '小型', 'Name': 'cdsmall'}, {'Bandwidth': 20, 'Cname': '中型', 'Name': 'cdmiddle'}, {'Bandwidth': 50, 'Cname': '大型', 'Name': 'cdlarge'}, {'Bandwidth': 100, 'Cname': '超大型', 'Name': 'cdsuperLarge'}]
    Version String 网关实例版本信息。
    示例值:1.0
    NetworkInstanceId String Type值为CCN时,该值表示云联网实例ID。
    示例值:ccn-gree226l
    CdcId String CDC 实例ID。
    示例值:cluster-gbo27yc4
    MaxConnection Integer SSL-VPN 客户端连接数。
    示例值:5
    BgpAsn Integer Bgp ASN
    示例值:61413

    VpnGatewayQuota

    VPN网关配额对象

    被如下接口引用:CreateVpnGateway, DescribeVpnGateways。

    名称 类型 描述
    Bandwidth Integer 带宽配额
    示例值:5
    Cname String 配额中文名称
    示例值:微小型
    Name String 配额英文名称
    示例值:mini

    VpnGatewayRoute

    VPN网关目的路由

    被如下接口引用:CreateVpnGatewayRoutes, DescribeVpnGatewayRoutes, ModifyVpnGatewayRoutes。

    名称 类型 必选 描述
    DestinationCidrBlock String 目的端IDC网段。
    示例值:10.0.0.0/16
    InstanceType String 下一跳类型(关联实例类型)可选值:"VPNCONN"(VPN通道), "CCN"(CCN实例)。
    示例值:VPNCONN
    InstanceId String 下一跳实例ID。
    示例值:vpc-awd131ca
    Priority Integer 优先级,可选值:0,100。
    示例值:0
    Status String 启用状态,可选值:"ENABLE"(启用),"DISABLE" (禁用)。
    示例值:ENABLE
    RouteId String 路由条目ID。
    示例值:vpnr-u2c2cfz8
    Type String 路由类型,可选值:"VPC"(VPC路由),"CCN"(云联网传播路由),"Static"(静态路由),"BGP"(BGP路由)。
    示例值:VPC
    CreateTime Timestamp 创建时间。
    示例值:2023-10-09 18:00:00
    UpdateTime Timestamp 更新时间。
    示例值:2023-10-09 18:00:00

    VpnGatewayRouteModify

    修改VPN状态参数

    被如下接口引用:ModifyVpnGatewayRoutes。

    名称 类型 必选 描述
    RouteId String VPN网关路由ID。
    示例值:vpnr-u1c0cwe7
    Status String VPN网关状态, ENABLE 启用, DISABLE禁用。
    示例值:ENABLE

    VpngwCcnRoutes

    VPN网关云联网路由信息

    被如下接口引用:DescribeVpnGatewayCcnRoutes, ModifyVpnGatewayCcnRoutes。

    名称 类型 必选 描述
    RouteId String 路由信息ID。
    示例值:vpnr-awda31c1
    Status String 路由信息是否启用。
    ENABLE:启用该路由
    DISABLE:不启用该路由
    示例值:ENABLE
    DestinationCidrBlock String 路由CIDR。
    示例值:10.0.0.0/16