当前位置:主页 > 查看内容

私有网络 数据结构 - API文档

发布时间:2021-09-28 00:00| 位朋友查看

简介:AccountAttribute 账户属性对象 被如下接口引用:DescribeAccountAttributes。 名称 类型 描述 AttributeName String 属性名 AttributeValues Array of String 属性值 Address 描述 EIP 信息 被如下接口引用:DescribeAddresses, DescribeIp6Addresses。 名……

AccountAttribute

账户属性对象

被如下接口引用:DescribeAccountAttributes。

名称 类型 描述
AttributeName String 属性名
AttributeValues Array of String 属性值

Address

描述 EIP 信息

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

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

AddressChargePrepaid

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

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

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

AddressTemplate

IP地址模板

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

名称 类型 描述
AddressTemplateName String IP地址模板名称。
AddressTemplateId String IP地址模板实例唯一ID。
AddressSet Array of String IP地址信息。
CreatedTime String 创建时间。

AddressTemplateGroup

IP地址模板集合

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

名称 类型 描述
AddressTemplateGroupName String IP地址模板集合名称。
AddressTemplateGroupId String IP地址模板集合实例ID,例如:ipmg-dih8xdbq。
AddressTemplateIdSet Array of String IP地址模板ID。
CreatedTime String 创建时间。
AddressTemplateSet Array of AddressTemplateItem IP地址模板实例。

AddressTemplateItem

地址信息

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

名称 类型 必选 描述
From String 起始地址。
To String 结束地址。

AddressTemplateSpecification

IP地址模版

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

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

AlgType

ALG协议类型

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

名称 类型 描述
Ftp Boolean Ftp协议Alg功能是否开启
Sip Boolean Sip协议Alg功能是否开启

AssistantCidr

VPC辅助CIDR信息。

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

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

BandwidthPackage

描述带宽包信息的结构

被如下接口引用:DescribeBandwidthPackages。

名称 类型 描述
BandwidthPackageId String 带宽包唯一标识Id
NetworkType String 带宽包类型,包括'BGP','SINGLEISP','ANYCAST'
ChargeType String 带宽包计费类型,包括'TOP5_POSTPAID_BY_MONTH'和'PERCENT95_POSTPAID_BY_MONTH'
BandwidthPackageName String 带宽包名称
CreatedTime Timestamp ISO8601 带宽包创建时间。按照ISO8601标准表示,并且使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ
Status String 带宽包状态,包括'CREATING','CREATED','DELETING','DELETED'
ResourceSet Array of Resource 带宽包资源信息
Bandwidth Integer 带宽包限速大小。单位:Mbps,-1表示不限速。

BandwidthPackageBillBandwidth

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

被如下接口引用:DescribeBandwidthPackageBillUsage。

名称 类型 描述
BandwidthUsage Integer 当前计费用量,单位为 Mbps

CCN

云联网(CCN)对象

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

名称 类型 描述
CcnId String 云联网唯一ID
CcnName String 云联网名称
CcnDescription String 云联网描述信息
InstanceCount Integer 关联实例数量
CreateTime Timestamp 创建时间
State String 实例状态, 'ISOLATED': 隔离中(欠费停服),'AVAILABLE':运行中。
QosLevel String 实例服务质量,’PT’:白金,'AU':金,'AG':银。
InstanceChargeType String 付费类型,PREPAID为预付费,POSTPAID为后付费。
注意:此字段可能返回 null,表示取不到有效值。
BandwidthLimitType String 限速类型,INTER_REGION_LIMIT为地域间限速;OUTER_REGION_LIMIT为地域出口限速。
注意:此字段可能返回 null,表示取不到有效值。
TagSet Array of Tag 标签键值对。
RoutePriorityFlag Boolean 是否支持云联网路由优先级的功能。False:不支持,True:支持。

CcnAttachedInstance

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

被如下接口引用:DescribeCcnAttachedInstances。

名称 类型 描述
CcnId String 云联网实例ID。
InstanceType String 关联实例类型:
  • VPC:私有网络
  • DIRECTCONNECT:专线网关
  • BMVPC:黑石私有网络
  • InstanceId String 关联实例ID。
    InstanceName String 关联实例名称。
    InstanceRegion String 关联实例所属大区,例如:ap-guangzhou。
    InstanceUin String 关联实例所属UIN(根账号)。
    CidrBlock Array of String 关联实例CIDR。
    State String 关联实例状态:
  • PENDING:申请中
  • ACTIVE:已连接
  • EXPIRED:已过期
  • REJECTED:已拒绝
  • DELETED:已删除
  • FAILED:失败的(2小时后将异步强制解关联)
  • ATTACHING:关联中
  • DETACHING:解关联中
  • DETACHFAILED:解关联失败(2小时后将异步强制解关联)
  • AttachedTime Timestamp 关联时间。
    CcnUin String 云联网所属UIN(根账号)。
    InstanceArea String 关联实例所属的大地域,如: CHINA_MAINLAND
    Description String 备注

    CcnBandwidthInfo

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

    被如下接口引用:GetCcnRegionBandwidthLimits。

    名称 类型 描述
    CcnId String 带宽所属的云联网ID。
    注意:此字段可能返回 null,表示取不到有效值。
    CreatedTime String 实例的创建时间。
    注意:此字段可能返回 null,表示取不到有效值。
    ExpiredTime String 实例的过期时间
    注意:此字段可能返回 null,表示取不到有效值。
    RegionFlowControlId String 带宽实例的唯一ID。
    注意:此字段可能返回 null,表示取不到有效值。
    RenewFlag String 带宽是否自动续费的标记。
    注意:此字段可能返回 null,表示取不到有效值。
    CcnRegionBandwidthLimit CcnRegionBandwidthLimit 描述带宽的地域和限速上限信息。在地域间限速的情况下才会返回参数,出口限速模式不返回。
    注意:此字段可能返回 null,表示取不到有效值。

    CcnInstance

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

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

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

    CcnRegionBandwidthLimit

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

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

    名称 类型 必选 描述
    Region String 地域,例如:ap-guangzhou
    BandwidthLimit Integer 出带宽上限,单位:Mbps
    IsBm Boolean 是否黑石地域,默认false
    DstRegion String 目的地域,例如:ap-shanghai
    注意:此字段可能返回 null,表示取不到有效值。
    DstIsBm Boolean 目的地域是否为黑石地域,默认false

    CcnRoute

    CCN路由策略对象

    被如下接口引用:DescribeCcnRoutes。

    名称 类型 描述
    RouteId String 路由策略ID
    DestinationCidrBlock String 目的端
    InstanceType String 下一跳类型(关联实例类型),所有类型:VPC、DIRECTCONNECT
    InstanceId String 下一跳(关联实例)
    InstanceName String 下一跳名称(关联实例名称)
    InstanceRegion String 下一跳所属地域(关联实例所属地域)
    UpdateTime Timestamp 更新时间
    Enabled Boolean 路由是否启用
    InstanceUin String 关联实例所属UIN(根账号)
    ExtraState String 路由的扩展状态
    IsBgp Boolean 是否动态路由
    RoutePriority Integer 路由优先级
    InstanceExtraName String 下一跳扩展名称(关联实例的扩展名称)

    CidrForCcn

    用于发布云联网的cidr信息

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

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

    ClassicLinkInstance

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

    被如下接口引用:DescribeClassicLinkInstances。

    名称 类型 描述
    VpcId String VPC实例ID
    InstanceId String 云服务器实例唯一ID

    ConflictItem

    冲突资源条目信息。

    被如下接口引用:CheckAssistantCidr。

    名称 类型 描述
    ConfilctId String 冲突资源的ID
    DestinationItem String 冲突目的资源

    ConflictSource

    冲突资源信息。

    被如下接口引用:CheckAssistantCidr。

    名称 类型 描述
    ConflictSourceId String 冲突资源ID
    SourceItem String 冲突资源
    ConflictItemSet Array of ConflictItem 冲突资源条目信息

    CrossBorderCompliance

    合规化审批单

    被如下接口引用:DescribeCrossBorderCompliance。

    名称 类型 描述
    ServiceProvider String 服务商,可选值:UNICOM
    ComplianceId Integer 合规化审批单ID
    Company String 公司全称。
    UniformSocialCreditCode String 统一社会信用代码。
    LegalPerson String 法定代表人。
    IssuingAuthority String 发证机关。
    BusinessLicense String 营业执照。
    BusinessAddress String 营业执照住所。
    PostCode Integer 邮编。
    Manager String 经办人。
    ManagerId String 经办人身份证号。
    ManagerIdCard String 经办人身份证。
    ManagerAddress String 经办人身份证地址。
    ManagerTelephone String 经办人联系电话。
    Email String 电子邮箱。
    ServiceHandlingForm String 服务受理单。
    AuthorizationLetter String 授权函。
    SafetyCommitment String 信息安全承诺书。
    ServiceStartDate Date 服务开始时间。
    ServiceEndDate Date 服务截止时间。
    State String 状态。待审批:PENDING,已通过:APPROVED,已拒绝:DENY
    CreatedTime Timestamp 审批单创建时间。

    CustomerGateway

    对端网关

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

    名称 类型 描述
    CustomerGatewayId String 用户网关唯一ID
    CustomerGatewayName String 网关名称
    IpAddress String 公网地址
    CreatedTime String 创建时间

    CustomerGatewayVendor

    对端网关厂商信息对象。

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

    名称 类型 必选 描述
    Platform String 平台。
    SoftwareVersion String 软件版本。
    VendorName String 供应商名称。

    CvmInstance

    云主机实例信息。

    被如下接口引用:DescribeVpcInstances。

    名称 类型 描述
    VpcId String VPC实例ID。
    SubnetId String 子网实例ID。
    InstanceId String 云主机实例ID
    InstanceName String 云主机名称。
    InstanceState String 云主机状态。
    CPU Integer 实例的CPU核数,单位:核。
    Memory Integer 实例内存容量,单位:GB。
    CreatedTime String 创建时间。
    InstanceType String 实例机型。
    EniLimit Integer 实例弹性网卡配额(包含主网卡)。
    EniIpLimit Integer 实例弹性网卡内网IP配额(包含主网卡)。
    InstanceEniCount Integer 实例已绑定弹性网卡的个数(包含主网卡)。

    DefaultVpcSubnet

    默认VPC和子网

    被如下接口引用:CreateDefaultVpc。

    名称 类型 描述
    VpcId String 默认VpcId
    SubnetId String 默认SubnetId

    DestinationIpPortTranslationNatRule

    NAT网关的端口转发规则

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

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

    DhcpIp

    描述 DhcpIp 信息

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

    名称 类型 描述
    DhcpIpId String DhcpIpID,是DhcpIp的唯一标识。
    VpcId String DhcpIp所在私有网络ID
    SubnetId String DhcpIp所在子网ID
    DhcpIpName String DhcpIp的名称。
    PrivateIpAddress String IP地址。
    AddressIp String 绑定EIP
    NetworkInterfaceId String DhcpIp关联弹性网卡ID
    InstanceId String 被绑定的实例ID
    State String 状态:
  • AVAILABLE:运行中
  • UNBIND:未绑定
  • CreatedTime Timestamp 创建时间。

    DirectConnectGateway

    专线网关对象。

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

    名称 类型 描述
    DirectConnectGatewayId String 专线网关ID
    DirectConnectGatewayName String 专线网关名称。
    VpcId String 专线网关关联VPC实例ID
    NetworkType String 关联网络类型:
  • VPC - 私有网络
  • CCN - 云联网
  • NetworkInstanceId String 关联网络实例ID
  • NetworkTypeVPC时,这里为私有网络实例ID
  • NetworkTypeCCN时,这里为云联网实例ID
  • GatewayType String 网关类型:
  • NORMAL - 标准型,注:云联网只支持标准型
  • NAT - NAT型

  • NAT类型支持网络地址转换配置,类型确定后不能修改;一个私有网络可以创建一个NAT类型的专线网关和一个非NAT类型的专线网关
    CreateTime Timestamp 创建时间。
    DirectConnectGatewayIp String 专线网关IP。
    CcnId String 专线网关关联CCN实例ID
    CcnRouteType String 云联网路由学习类型:
  • BGP - 自动学习。
  • STATIC - 静态,即用户配置。
  • EnableBGP Boolean 是否启用BGP。
    EnableBGPCommunity Boolean 开启和关闭BGP的community属性。
    NatGatewayId String 绑定的NAT网关ID。
    注意:此字段可能返回 null,表示取不到有效值。
    VXLANSupport Array of Boolean 专线网关是否支持VXLAN架构
    注意:此字段可能返回 null,表示取不到有效值。
    ModeType String 云联网路由发布模式:standard(标准模式)、exquisite(精细模式)。
    注意:此字段可能返回 null,表示取不到有效值。

    DirectConnectGatewayCcnRoute

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

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

    名称 类型 描述
    RouteId String 路由ID。
    DestinationCidrBlock String IDC网段。
    ASPath Array of String BGPAS-Path属性。

    EndPoint

    终端节点详情。

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

    名称 类型 描述
    EndPointId String 终端节点ID。
    VpcId String VPCID。
    SubnetId String 子网ID。
    EndPointOwner String APPID。
    EndPointName String 终端节点名称。
    ServiceVpcId String 终端节点服务的VPCID。
    ServiceVip String 终端节点服务的VIP。
    EndPointServiceId String 终端节点服务的ID。
    EndPointVip String 终端节点的VIP。
    State String 终端节点状态,ACTIVE:可用,PENDING:待接受,ACCEPTING:接受中,REJECTED:已拒绝,FAILED:失败。
    CreateTime String 创建时间。
    GroupSet Array of String 终端节点绑定的安全组实例ID列表。
    ServiceName String 终端节点服务名称。
    注意:此字段可能返回 null,表示取不到有效值。

    EndPointService

    终端节点服务对象。

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

    名称 类型 描述
    EndPointServiceId String 终端节点服务ID
    VpcId String VPCID。
    ServiceOwner String APPID。
    ServiceName String 终端节点服务名称。
    ServiceVip String 后端服务的VIP。
    ServiceInstanceId String 后端服务的ID,比如lb-xxx。
    AutoAcceptFlag Boolean 是否自动接受。
    EndPointCount Integer 关联的终端节点个数。
    注意:此字段可能返回 null,表示取不到有效值。
    EndPointSet Array of EndPoint 终端节点对象数组。
    注意:此字段可能返回 null,表示取不到有效值。
    CreateTime String 创建时间。

    Filter

    过滤器

    被如下接口引用:DescribeAddressTemplateGroups, DescribeAddressTemplates, DescribeAddresses, DescribeAssistantCidr, DescribeBandwidthPackageResources, DescribeBandwidthPackages, DescribeCcnAttachedInstances, DescribeCcnRoutes, DescribeCcns, DescribeCustomerGateways, DescribeDhcpIps, DescribeDirectConnectGateways, DescribeFlowLogs, DescribeHaVips, DescribeIp6Addresses, DescribeIp6Translators, DescribeLocalGateway, DescribeNatGatewayDestinationIpPortTranslationNatRules, DescribeNatGatewaySourceIpTranslationNatRules, DescribeNatGateways, DescribeNetDetectStates, DescribeNetDetects, DescribeNetworkAcls, DescribeNetworkInterfaces, DescribeRouteTables, DescribeSecurityGroups, DescribeServiceTemplateGroups, DescribeServiceTemplates, DescribeSubnets, DescribeVpcEndPoint, DescribeVpcEndPointService, DescribeVpcEndPointServiceWhiteList, DescribeVpcInstances, DescribeVpcs, DescribeVpnConnections, GetCcnRegionBandwidthLimits。

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

    FilterObject

    过滤器键值对

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

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

    FlowLog

    流日志

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

    名称 类型 描述
    VpcId String 私用网络ID或者统一ID,建议使用统一ID
    FlowLogId String 流日志唯一ID
    FlowLogName String 流日志实例名字
    ResourceType String 流日志所属资源类型,VPC|SUBNET|NETWORKINTERFACE
    ResourceId String 资源唯一ID
    TrafficType String 流日志采集类型,ACCEPT|REJECT|ALL
    CloudLogId String 流日志存储ID
    CloudLogState String 流日志存储ID状态
    FlowLogDescription String 流日志描述信息
    CreatedTime String 流日志创建时间
    TagSet Array of Tag 标签列表,例如:[{"Key": "city", "Value": "shanghai"}]

    GatewayFlowMonitorDetail

    网关流量监控明细

    被如下接口引用:DescribeGatewayFlowMonitorDetail。

    名称 类型 描述
    PrivateIpAddress String 来源IP
    InPkg Integer 入包量。
    OutPkg Integer 出包量。
    InTraffic Integer 入流量,单位:Byte
    OutTraffic Integer 出流量,单位:Byte

    GatewayQos

    网关流控带宽信息

    被如下接口引用:DescribeGatewayFlowQos。

    名称 类型 描述
    VpcId String VPC实例ID。
    IpAddress String 云服务器内网IP。
    Bandwidth Integer 流控带宽值。
    CreateTime String 创建时间。

    HaVip

    描述 HAVIP 信息

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

    名称 类型 描述
    HaVipId String HAVIPID,是HAVIP的唯一标识。
    HaVipName String HAVIP名称。
    Vip String 虚拟IP地址。
    VpcId String HAVIP所在私有网络ID
    SubnetId String HAVIP所在子网ID
    NetworkInterfaceId String HAVIP关联弹性网卡ID
    InstanceId String 被绑定的实例ID
    AddressIp String 绑定EIP
    State String 状态:
  • AVAILABLE:运行中
  • UNBIND:未绑定
  • CreatedTime Timestamp 创建时间。
    Business String 使用havip的业务标识。

    IKEOptionsSpecification

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

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

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

    IPSECOptionsSpecification

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

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

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

    InstanceChargePrepaid

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

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

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

    InstanceStatistic

    用于描述实例的统计信息

    被如下接口引用:DescribeSecurityGroupAssociationStatistics。

    名称 类型 描述
    InstanceType String 实例的类型
    InstanceCount Integer 实例的个数

    Ip6Rule

    IPV6转换规则

    被如下接口引用:DescribeIp6Translators。

    名称 类型 描述
    Ip6RuleId String IPV6转换规则唯一ID,形如rule6-xxxxxxxx
    Ip6RuleName String IPV6转换规则名称
    Vip6 String IPV6地址
    Vport6 Integer IPV6端口号
    Protocol String 协议类型,支持TCP/UDP
    Vip String IPV4地址
    Vport Integer IPV4端口号
    RuleStatus String 转换规则状态,限于CREATING,RUNNING,DELETING,MODIFYING
    CreatedTime Timestamp ISO8601 转换规则创建时间

    Ip6RuleInfo

    IPV6转换规则

    被如下接口引用:AddIp6Rules。

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

    Ip6Translator

    IPV6转换实例信息

    被如下接口引用:DescribeIp6Translators。

    名称 类型 描述
    Ip6TranslatorId String IPV6转换实例唯一ID,形如ip6-xxxxxxxx
    Ip6TranslatorName String IPV6转换实例名称
    Vip6 String IPV6地址
    IspName String IPV6转换地址所属运营商
    TranslatorStatus String 转换实例状态,限于CREATING,RUNNING,DELETING,MODIFYING
    CreatedTime Timestamp ISO8601 IPV6转换实例创建时间
    Ip6RuleCount Integer 绑定的IPV6转换规则数量
    IP6RuleSet Array of Ip6Rule IPV6转换规则信息

    IpField

    IP在线查询的字段信息

    被如下接口引用:DescribeIpGeolocationInfos。

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

    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,表示取不到有效值。
    Comment String 注释信息。目前的填充值为移动接入用户的APN值,如无APN属性则为空
    注意:此字段可能返回 null,表示取不到有效值。
    AddressIp String IP地址
    注意:此字段可能返回 null,表示取不到有效值。

    Ipv6Address

    IPv6地址信息。

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

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

    IPv6子网段对象。

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

    名称 类型 必选 描述
    SubnetId String 子网实例ID。形如:subnet-pxir56ns
    Ipv6CidrBlock String IPv6子网段。形如:3402:4e00:20:1001::/64

    ItemPrice

    单项计费价格信息

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

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

    LocalGateway

    本地网关信息

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

    名称 类型 描述
    CdcId String CDC实例ID
    VpcId String VPC实例ID
    UniqLocalGwId String 本地网关实例ID
    LocalGatewayName String 本地网关名称
    LocalGwIp String 本地网关IP地址
    CreateTime String 本地网关创建时间

    NatGateway

    NAT网关对象。

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

    名称 类型 描述
    NatGatewayId String NAT网关的ID。
    NatGatewayName String NAT网关的名称。
    CreatedTime String NAT网关创建的时间。
    State String NAT网关的状态。
    'PENDING':生产中,'DELETING':删除中,'AVAILABLE':运行中,'UPDATING':升级中,
    ‘FAILED’:失败。
    InternetMaxBandwidthOut Integer 网关最大外网出带宽(单位:Mbps)。
    MaxConcurrentConnection Integer 网关并发连接上限。
    PublicIpAddressSet Array of NatGatewayAddress 绑定NAT网关的公网IP对象数组。
    NetworkState String NAT网关网络状态。“AVAILABLE”:运行中, “UNAVAILABLE”:不可用, “INSUFFICIENT”:欠费停服。
    DestinationIpPortTranslationNatRuleSet Array of DestinationIpPortTranslationNatRule NAT网关的端口转发规则。
    VpcId String VPC实例ID。
    Zone String NAT网关所在的可用区。
    DirectConnectGatewayIds Array of String 绑定的专线网关ID。
    注意:此字段可能返回 null,表示取不到有效值。
    SubnetId String 所属子网ID。
    注意:此字段可能返回 null,表示取不到有效值。
    TagSet Array of Tag 标签键值对。
    SecurityGroupSet Array of String NAT网关绑定的安全组列表
    注意:此字段可能返回 null,表示取不到有效值。

    NatGatewayAddress

    NAT网关绑定的弹性IP

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

    名称 类型 描述
    AddressId String 弹性公网IP(EIP)的唯一 ID,形如:eip-11112222
    PublicIpAddress String 外网IP地址,形如:123.121.34.33
    IsBlocked Boolean 资源封堵状态。true表示弹性ip处于封堵状态,false表示弹性ip处于未封堵状态。

    NatGatewayDestinationIpPortTranslationNatRule

    NAT网关的端口转发规则

    被如下接口引用:DescribeNatGatewayDestinationIpPortTranslationNatRules。

    名称 类型 描述
    IpProtocol String 网络协议,可选值:TCPUDP
    PublicIpAddress String 弹性IP。
    PublicPort Integer 公网端口。
    PrivateIpAddress String 内网地址。
    PrivatePort Integer 内网端口。
    Description String NAT网关转发规则描述。
    NatGatewayId String NAT网关的ID。
    注意:此字段可能返回 null,表示取不到有效值。
    VpcId String 私有网络VPC的ID。
    注意:此字段可能返回 null,表示取不到有效值。
    CreatedTime String NAT网关转发规则创建时间。
    注意:此字段可能返回 null,表示取不到有效值。

    NetDetect

    网络探测对象。

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

    名称 类型 描述
    VpcId String VPC实例ID。形如:vpc-12345678
    VpcName String VPC实例名称。
    SubnetId String 子网实例ID。形如:subnet-12345678。
    SubnetName String 子网实例名称。
    NetDetectId String 网络探测实例ID。形如:netd-12345678。
    NetDetectName String 网络探测名称,最大长度不能超过60个字节。
    DetectDestinationIp Array of String 探测目的IPv4地址数组,最多两个。
    DetectSourceIp Array of String 系统自动分配的探测源IPv4数组。长度为2。
    NextHopType String 下一跳类型,目前我们支持的类型有:
    VPN:VPN网关;
    DIRECTCONNECT:专线网关;
    PEERCONNECTION:对等连接;
    NAT:NAT网关;
    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;
    NextHopName String 下一跳网关名称。
    注意:此字段可能返回 null,表示取不到有效值。
    NetDetectDescription String 网络探测描述。
    注意:此字段可能返回 null,表示取不到有效值。
    CreateTime Timestamp 创建时间。
    注意:此字段可能返回 null,表示取不到有效值。

    NetDetectIpState

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

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

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

    NetDetectState

    网络探测验证结果。

    被如下接口引用:DescribeNetDetectStates。

    名称 类型 描述
    NetDetectId String 网络探测实例ID。形如:netd-12345678。
    NetDetectIpStateSet Array of NetDetectIpState 网络探测目的IP验证结果对象数组。

    NetworkAcl

    网络ACL

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

    名称 类型 描述
    VpcId String VPC实例ID
    NetworkAclId String 网络ACL实例ID
    NetworkAclName String 网络ACL名称,最大长度为60。
    CreatedTime String 创建时间。
    SubnetSet Array of Subnet 网络ACL关联的子网数组。
    IngressEntries Array of NetworkAclEntry 网络ACl入站规则。
    EgressEntries Array of NetworkAclEntry 网络ACL出站规则。

    NetworkAclEntry

    网络ACL规则。

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

    名称 类型 必选 描述
    ModifyTime String 修改时间。
    Protocol String 协议, 取值: TCP,UDP, ICMP, ALL。
    Port String 端口(all, 单个port, range)。当Protocol为ALL或ICMP时,不能指定Port。
    CidrBlock String 网段或IP(互斥)。
    Ipv6CidrBlock String 网段或IPv6(互斥)。
    Action String ACCEPT 或 DROP。
    Description String 规则描述,最大长度100。

    NetworkAclEntrySet

    网络ACL规则集合

    被如下接口引用:ModifyNetworkAclEntries。

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

    NetworkInterface

    弹性网卡

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

    名称 类型 描述
    NetworkInterfaceId String 弹性网卡实例ID,例如:eni-f1xjkw1b。
    NetworkInterfaceName String 弹性网卡名称。
    NetworkInterfaceDescription String 弹性网卡描述。
    SubnetId String 子网实例ID。
    VpcId String VPC实例ID。
    GroupSet Array of String 绑定的安全组。
    Primary Boolean 是否是主网卡。
    MacAddress String MAC地址。
    State String 弹性网卡状态:
  • PENDING:创建中
  • AVAILABLE:可用的
  • ATTACHING:绑定中
  • DETACHING:解绑中
  • DELETING:删除中
  • PrivateIpAddressSet Array of PrivateIpAddressSpecification 内网IP信息。
    Attachment NetworkInterfaceAttachment 绑定的云服务器对象。
    注意:此字段可能返回 null,表示取不到有效值。
    Zone String 可用区。
    CreatedTime String 创建时间。
    Ipv6AddressSet Array of Ipv6Address IPv6地址列表。
    TagSet Array of Tag 标签键值对。
    EniType Integer 网卡类型。0 - 弹性网卡;1 - evm弹性网卡。
    Business String 网卡绑定的子机类型:cvm,eks。
    注意:此字段可能返回 null,表示取不到有效值。
    CdcId String 网卡所关联的CDC实例ID。
    注意:此字段可能返回 null,表示取不到有效值。

    NetworkInterfaceAttachment

    弹性网卡绑定关系

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

    名称 类型 描述
    InstanceId String 云主机实例ID。
    DeviceIndex Integer 网卡在云主机实例内的序号。
    InstanceAccountId String 云主机所有者账户信息。
    AttachTime String 绑定时间。

    Price

    价格

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

    名称 类型 描述
    InstancePrice ItemPrice 实例价格。
    BandwidthPrice ItemPrice 网络价格。

    PrivateIpAddressSpecification

    内网IP信息

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

    名称 类型 必选 描述
    PrivateIpAddress String 内网IP地址。
    Primary Boolean 是否是主IP。
    PublicIpAddress String 公网IP地址。
    AddressId String EIP实例ID,例如:eip-11112222。
    Description String 内网IP描述信息。
    IsWanIpBlocked Boolean 公网IP是否被封堵。
    State String IP状态:
    PENDING:生产中
    MIGRATING:迁移中
    DELETING:删除中
    AVAILABLE:可用的

    ProductQuota

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

    被如下接口引用:DescribeProductQuota。

    名称 类型 描述
    QuotaId String 产品配额ID
    QuotaName String 产品配额名称
    QuotaCurrent Integer 产品当前配额
    QuotaLimit Integer 产品配额上限
    QuotaRegion Boolean 产品配额是否有地域属性

    Quota

    描述配额信息

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

    名称 类型 描述
    QuotaId String 配额名称,取值范围:
  • TOTAL_EIP_QUOTA:用户当前地域下EIP的配额数;
  • DAILY_EIP_APPLY:用户当前地域下今日申购次数;
  • DAILY_PUBLIC_IP_ASSIGN:用户当前地域下,重新分配公网 IP次数。
  • QuotaCurrent Integer 当前数量
    QuotaLimit Integer 配额数量

    ReferredSecurityGroup

    安全组被引用信息

    被如下接口引用:DescribeSecurityGroupReferences。

    名称 类型 描述
    SecurityGroupId String 安全组实例ID。
    ReferredSecurityGroupIds Array of String 引用安全组实例ID(SecurityGroupId)的所有安全组实例ID。

    Resource

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

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

    名称 类型 描述
    ResourceType String 带宽包资源类型,包括'Address'和'LoadBalance'
    ResourceId String 带宽包资源Id,形如'eip-xxxx', 'lb-xxxx'
    AddressIp String 带宽包资源Ip

    ResourceDashboard

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

    被如下接口引用:DescribeVpcResourceDashboard。

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

    Route

    路由策略对象

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

    名称 类型 必选 描述
    DestinationCidrBlock String 目的网段,取值不能在私有网络网段内,例如:112.20.51.0/24。
    GatewayType String 下一跳类型,目前我们支持的类型有:
    CVM:公网网关类型的云服务器;
    VPN:VPN网关;
    DIRECTCONNECT:专线网关;
    PEERCONNECTION:对等连接;
    SSLVPN:sslvpn网关;
    NAT:NAT网关;
    NORMAL_CVM:普通云服务器;
    EIP:云服务器的公网IP;
    CCN:云联网;
    LOCAL_GATEWAY:本地网关。
    GatewayId String 下一跳地址,这里只需要指定不同下一跳类型的网关ID,系统会自动匹配到下一跳地址。
    特别注意:当 GatewayType 为 EIP 时,GatewayId 固定值 '0'
    RouteId Integer 路由策略ID。IPv4路由策略ID是有意义的值,IPv6路由策略是无意义的值0。后续建议完全使用字符串唯一ID RouteItemId操作路由策略。
    RouteDescription String 路由策略描述。
    Enabled Boolean 是否启用
    RouteType String 路由类型,目前我们支持的类型有:
    USER:用户路由;
    NETD:网络探测路由,创建网络探测实例时,系统默认下发,不可编辑与删除;
    CCN:云联网路由,系统默认下发,不可编辑与删除。
    用户只能添加和操作 USER 类型的路由。
    RouteTableId String 路由表实例ID,例如:rtb-azd4dt1c。
    DestinationIpv6CidrBlock String 目的IPv6网段,取值不能在私有网络网段内,例如:2402:4e00:1000:810b::/64。
    RouteItemId String 路由唯一策略ID。
    PublishedToVbc Boolean 路由策略是否发布到云联网。
    注意:此字段可能返回 null,表示取不到有效值。
    CreatedTime Timestamp 路由策略创建时间

    RouteConflict

    路由冲突对象

    被如下接口引用:DescribeRouteConflicts。

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

    RouteTable

    路由表对象

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

    名称 类型 描述
    VpcId String VPC实例ID。
    RouteTableId String 路由表实例ID,例如:rtb-azd4dt1c。
    RouteTableName String 路由表名称。
    AssociationSet Array of RouteTableAssociation 路由表关联关系。
    RouteSet Array of Route IPv4路由策略集合。
    Main Boolean 是否默认路由表。
    CreatedTime String 创建时间。
    TagSet Array of Tag 标签键值对。
    LocalCidrForCcn Array of CidrForCcn local路由是否发布云联网。
    注意:此字段可能返回 null,表示取不到有效值。

    RouteTableAssociation

    路由表关联关系

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

    名称 类型 描述
    SubnetId String 子网实例ID。
    RouteTableId String 路由表实例ID。

    SecurityGroup

    安全组对象

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

    名称 类型 必选 描述
    SecurityGroupId String 安全组实例ID,例如:sg-ohuuioma。
    SecurityGroupName String 安全组名称,可任意命名,但不得超过60个字符。
    SecurityGroupDesc String 安全组备注,最多100个字符。
    ProjectId String 项目id,默认0。可在qcloud控制台项目管理页面查询到。
    IsDefault Boolean 是否是默认安全组,默认安全组不支持删除。
    CreatedTime String 安全组创建时间。
    TagSet Array of Tag 标签键值对。

    SecurityGroupAssociationStatistics

    安全组关联的实例统计

    被如下接口引用:DescribeSecurityGroupAssociationStatistics。

    名称 类型 描述
    SecurityGroupId String 安全组实例ID。
    CVM Integer 云服务器实例数。
    CDB Integer MySQL数据库实例数。
    ENI Integer 弹性网卡实例数。
    SG Integer 被安全组引用数。
    CLB Integer 负载均衡实例数。
    InstanceStatistics Array of InstanceStatistic 全量实例的绑定统计。
    TotalCount Integer 所有资源的总计数(不包含被安全组引用数)。

    SecurityGroupLimitSet

    用户安全组配额限制。

    被如下接口引用:DescribeSecurityGroupLimits。

    名称 类型 描述
    SecurityGroupLimit Integer 每个项目每个地域可创建安全组数
    SecurityGroupPolicyLimit Integer 安全组下的最大规则数
    ReferedSecurityGroupLimit Integer 安全组下嵌套安全组规则数
    SecurityGroupInstanceLimit Integer 单安全组关联实例数
    InstanceSecurityGroupLimit Integer 实例关联安全组数

    SecurityGroupPolicy

    安全组规则对象

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

    名称 类型 必选 描述
    PolicyIndex Integer 安全组规则索引号,值会随着安全组规则的变更动态变化。使用PolicyIndex时,请先调用DescribeSecurityGroupPolicies获取到规则的PolicyIndex,并且结合返回值中的Version一起使用处理规则。
    Protocol String 协议, 取值: TCP,UDP,ICMP,ICMPv6,ALL。
    Port String 端口(all, 离散port, range)。
    ServiceTemplate ServiceTemplateSpecification 协议端口ID或者协议端口组ID。ServiceTemplate和Protocol+Port互斥。
    CidrBlock String 网段或IP(互斥)。
    Ipv6CidrBlock String 网段或IPv6(互斥)。
    SecurityGroupId String 安全组实例ID,例如:sg-ohuuioma。
    AddressTemplate AddressTemplateSpecification IP地址ID或者ID地址组ID。
    Action String ACCEPT 或 DROP。
    PolicyDescription String 安全组规则描述。
    ModifyTime String 安全组最近修改时间。

    SecurityGroupPolicySet

    安全组规则集合

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

    名称 类型 必选 描述
    Version String 安全组规则当前版本。用户每次更新安全规则版本会自动加1,防止更新的路由规则已过期,不填不考虑冲突。
    Egress Array of SecurityGroupPolicy 出站规则。
    Ingress Array of SecurityGroupPolicy 入站规则。

    SecurityPolicyDatabase

    SecurityPolicyDatabase策略

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

    名称 类型 必选 描述
    LocalCidrBlock String 本端网段
    RemoteCidrBlock Array of String 对端网段

    ServiceTemplate

    协议端口模板

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

    名称 类型 描述
    ServiceTemplateId String 协议端口实例ID,例如:ppm-f5n1f8da。
    ServiceTemplateName String 模板名称。
    ServiceSet Array of String 协议端口信息。
    CreatedTime String 创建时间。

    ServiceTemplateGroup

    协议端口模板集合

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

    名称 类型 描述
    ServiceTemplateGroupId String 协议端口模板集合实例ID,例如:ppmg-2klmrefu。
    ServiceTemplateGroupName String 协议端口模板集合名称。
    ServiceTemplateIdSet Array of String 协议端口模板实例ID。
    CreatedTime String 创建时间。
    ServiceTemplateSet Array of ServiceTemplate 协议端口模板实例信息。

    ServiceTemplateSpecification

    协议端口模版

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

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

    SourceIpTranslationNatRule

    NAT的SNAT规则

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

    名称 类型 必选 描述
    ResourceId String 资源ID
    ResourceType String 资源类型,目前包含SUBNET、NETWORKINTERFACE
    注意:此字段可能返回 null,表示取不到有效值。
    PrivateIpAddress String 源IP/网段
    PublicIpAddresses Array of String 弹性IP地址池
    Description String 描述
    NatGatewaySnatId String Snat规则ID
    NatGatewayId String NAT网关的ID。
    注意:此字段可能返回 null,表示取不到有效值。
    VpcId String 私有网络VPC的ID。
    注意:此字段可能返回 null,表示取不到有效值。
    CreatedTime String NAT网关SNAT规则创建时间。
    注意:此字段可能返回 null,表示取不到有效值。

    Subnet

    子网对象

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

    名称 类型 描述
    VpcId String VPC实例ID
    SubnetId String 子网实例ID,例如:subnet-bthucmmy。
    SubnetName String 子网名称。
    CidrBlock String 子网的 IPv4 CIDR
    IsDefault Boolean 是否默认子网。
    EnableBroadcast Boolean 是否开启广播。
    Zone String 可用区。
    RouteTableId String 路由表实例ID,例如:rtb-l2h8d7c2。
    CreatedTime String 创建时间。
    AvailableIpAddressCount Integer 可用IPv4数。
    Ipv6CidrBlock String 子网的 IPv6 CIDR
    NetworkAclId String 关联ACLID
    IsRemoteVpcSnat Boolean 是否为 SNAT 地址池子网。
    TotalIpAddressCount Integer 子网IPv4总数。
    TagSet Array of Tag 标签键值对。
    CdcId String CDC实例ID。
    注意:此字段可能返回 null,表示取不到有效值。
    IsCdcSubnet Integer 是否是CDC所属子网。0:否 1:是
    注意:此字段可能返回 null,表示取不到有效值。

    SubnetInput

    子网对象

    被如下接口引用:CreateSubnets。

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

    Tag

    标签键值对

    被如下接口引用:AllocateAddresses, CloneSecurityGroup, CreateAndAttachNetworkInterface, CreateAssistantCidr, CreateBandwidthPackage, CreateCcn, CreateCustomerGateway, CreateDefaultSecurityGroup, CreateFlowLog, CreateNatGateway, CreateNetworkAcl, CreateNetworkInterface, CreateRouteTable, CreateRoutes, CreateSecurityGroup, CreateSecurityGroupWithPolicies, CreateSubnet, CreateSubnets, CreateVpc, CreateVpnConnection, CreateVpnGateway, DescribeAssistantCidr, DescribeCcns, DescribeFlowLog, DescribeFlowLogs, DescribeNatGateways, DescribeNetworkAcls, DescribeNetworkInterfaces, DescribeRouteTables, DescribeSecurityGroups, DescribeSubnets, DescribeVpcs, ModifyAssistantCidr。

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

    TemplateLimit

    参数模板配额

    被如下接口引用:DescribeTemplateLimits。

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

    Vpc

    私有网络(VPC)对象。

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

    名称 类型 描述
    VpcName String VPC名称。
    VpcId String VPC实例ID,例如:vpc-azd4dt1c。
    CidrBlock String VPCIPv4 CIDR
    IsDefault Boolean 是否默认VPC
    EnableMulticast Boolean 是否开启组播。
    CreatedTime String 创建时间。
    DnsServerSet Array of String DNS列表。
    DomainName String DHCP域名选项值。
    DhcpOptionsId String DHCP选项集ID
    EnableDhcp Boolean 是否开启DHCP
    Ipv6CidrBlock String VPCIPv6 CIDR
    TagSet Array of Tag 标签键值对
    AssistantCidrSet Array of AssistantCidr 辅助CIDR
    注意:此字段可能返回 null,表示取不到有效值。

    VpcEndPointServiceUser

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

    被如下接口引用:DescribeVpcEndPointServiceWhiteList。

    名称 类型 描述
    Owner Integer AppId。
    UserUin String Uin。
    Description String 描述信息。
    CreateTime String 创建时间。
    EndPointServiceId String 终端节点服务ID。

    VpcIpv6Address

    VPC内网IPv6对象。

    被如下接口引用:DescribeVpcIpv6Addresses。

    名称 类型 描述
    Ipv6Address String VPCIPv6地址。
    CidrBlock String 所属子网 IPv6 CIDR
    Ipv6AddressType String IPv6类型。
    CreatedTime String IPv6申请时间。

    VpcLimit

    私有网络配额

    被如下接口引用:DescribeVpcLimits。

    名称 类型 描述
    LimitType String 私有网络配额描述
    LimitValue Integer 私有网络配额值

    VpcPrivateIpAddress

    VPC内网IP对象。

    被如下接口引用:DescribeVpcPrivateIpAddresses。

    名称 类型 描述
    PrivateIpAddress String VPC内网IP
    CidrBlock String 所属子网CIDR
    PrivateIpAddressType String 内网IP类型。
    CreatedTime Timestamp IP申请时间。

    VpnConnection

    VPN通道对象。

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

    名称 类型 描述
    VpnConnectionId String 通道实例ID。
    VpnConnectionName String 通道名称。
    VpcId String VPC实例ID。
    VpnGatewayId String VPN网关实例ID。
    CustomerGatewayId String 对端网关实例ID。
    PreShareKey String 预共享密钥。
    VpnProto String 通道传输协议。
    EncryptProto String 通道加密协议。
    RouteType String 路由类型。
    CreatedTime Timestamp 创建时间。
    State String 通道的生产状态,PENDING:生产中,AVAILABLE:运行中,DELETING:删除中。
    NetStatus String 通道连接状态,AVAILABLE:已连接。
    SecurityPolicyDatabaseSet Array of SecurityPolicyDatabase SPD。
    IKEOptionsSpecification IKEOptionsSpecification IKE选项。
    IPSECOptionsSpecification IPSECOptionsSpecification IPSEC选择。
    EnableHealthCheck Boolean 是否支持健康状态探测
    HealthCheckLocalIp String 本端探测ip
    HealthCheckRemoteIp String 对端探测ip
    HealthCheckStatus String 通道健康检查状态,AVAILABLE:正常,UNAVAILABLE:不正常。 未配置健康检查不返回该对象

    VpnGateway

    VPN网关对象。

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

    名称 类型 描述
    VpnGatewayId String 网关实例ID。
    VpcId String VPC实例ID。
    VpnGatewayName String 网关实例名称。
    Type String 网关实例类型:'IPSEC', 'SSL','CCN'。
    State String 网关实例状态, 'PENDING':生产中,'DELETING':删除中,'AVAILABLE':运行中。
    PublicIpAddress String 网关公网IP。
    RenewFlag String 网关续费类型:'NOTIFY_AND_MANUAL_RENEW':手动续费,'NOTIFY_AND_AUTO_RENEW':自动续费,'NOT_NOTIFY_AND_NOT_RENEW':到期不续费。
    InstanceChargeType String 网关付费类型:POSTPAID_BY_HOUR:按小时后付费,PREPAID:包年包月预付费,
    InternetMaxBandwidthOut Integer 网关出带宽。
    CreatedTime Timestamp 创建时间。
    ExpiredTime Timestamp 预付费网关过期时间。
    IsAddressBlocked Boolean 公网IP是否被封堵。
    NewPurchasePlan String 计费模式变更,PREPAID_TO_POSTPAID:包年包月预付费到期转按小时后付费。
    RestrictState String 网关计费装,PROTECTIVELY_ISOLATED:被安全隔离的实例,NORMAL:正常。
    Zone String 可用区,如:ap-guangzhou-2
    VpnGatewayQuotaSet Array of VpnGatewayQuota 网关带宽配额信息
    Version String 网关实例版本信息
    NetworkInstanceId String Type值为CCN时,该值表示云联网实例ID

    VpnGatewayQuota

    VPN网关配额对象

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

    名称 类型 描述
    Bandwidth Integer 带宽配额
    Cname String 配额中文名称
    Name String 配额英文名称

    VpngwCcnRoutes

    VPN网关云联网路由信息

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

    名称 类型 必选 描述
    RouteId String 路由信息ID
    Status String 路由信息是否启用
    ENABLE:启用该路由
    DISABLE:不启用该路由

    本站部分内容转载于网络,版权归原作者所有,转载之目的在于传播更多优秀技术内容,如有侵权请联系QQ/微信:153890879删除,谢谢!

    推荐图文

    • 周排行
    • 月排行
    • 总排行

    随机推荐