数据结构

最近更新时间: 2024-09-03 18:49:44

TcapAccessPoint

Tcap 通道接入点信息

被如下接口引用:

名称 必选 允许NULL 类型 描述
Id 否 否 Int64 接入点 ID
Country 否 否 String 接入点所在国家
City 否 否 String 接入点所在城市
Idc 否 否 String 接入点所在机房
Type 否 否 String 接入点类型
Valid 否 否 Bool 接入点当前是否可用

CloudAttachIapInfo

高速上云服务提供商信息

被如下接口引用:

名称 必选 允许NULL 类型 描述
AppId 是 否 String 高速上云服务提供商的AppId信息

SwitchNetdevice

保存在DCOS系统中的交换机设备

被如下接口引用:

名称 必选 允许NULL 类型 描述
ManagementIp 是 否 String 云控制器使用的管理IP
ManagementPort 是 是 String 云控制器使用的管理端口,为空时,业务使用默认值
Name 是 否 String 交换机名称
Manufacturer 是 否 String 交换机厂商,比如为 cisco, h3c, huawei 之一,其他字符串不支持
Model 是 否 String 交换机型号

CloudAttachGatewayInfo

高速上云网关信息

被如下接口引用:

名称 必选 允许NULL 类型 描述
InstanceId 否 否 String 高速上云服务网关实例信息CreateCloudAttachServiceGateway:入参不填DeleteCloudAttachServiceGateway:入参必填DescribeCloudAttachServiceGateways:入参选填UpdateCloudAttachServiceGateway:入参必填
UniqCasId 否 否 String 高速上云服务实例IDCreateCloudAttachServiceGateway:入参必填DeleteCloudAttachServiceGateway:入参不填DescribeCloudAttachServiceGateways:入参选填UpdateCloudAttachServiceGateway:入参不填
Name 否 否 String 高速上云服务网关名称CreateCloudAttachServiceGateway:入参必填DeleteCloudAttachServiceGateway:入参不填DescribeCloudAttachServiceGateways:入参不填UpdateCloudAttachServiceGateway:入参选填
IapId 否 否 String 合作伙伴的AppId。只作为出参使用
DcId 否 否 String 专线IDCreateCloudAttachServiceGateway:入参必填DeleteCloudAttachServiceGateway:入参不填DescribeCloudAttachServiceGateways:入参选填UpdateCloudAttachServiceGateway:入参不填
VlanId 否 否 Uint64 vlan IDCreateCloudAttachServiceGateway:入参必填DeleteCloudAttachServiceGateway:入参不填DescribeCloudAttachServiceGateways:入参选填UpdateCloudAttachServiceGateway:入参不填
Bandwidth 否 否 Uint64 带宽信息,单位为MBCreateCloudAttachServiceGateway:入参必填DeleteCloudAttachServiceGateway:入参不填DescribeCloudAttachServiceGateways:入参选填UpdateCloudAttachServiceGateway:入参选填
ConnLocalIp 否 否 String 腾讯侧互联IPCreateCloudAttachServiceGateway:入参必填DeleteCloudAttachServiceGateway:入参不填DescribeCloudAttachServiceGateways:入参不填UpdateCloudAttachServiceGateway:入参选填
ConnPeerIp 否 否 String 用户侧互联IPCreateCloudAttachServiceGateway:入参必填DeleteCloudAttachServiceGateway:入参不填DescribeCloudAttachServiceGateways:入参不填UpdateCloudAttachServiceGateway:入参选填
ConnIpMask 否 否 String 互联IP掩码CreateCloudAttachServiceGateway:入参必填DeleteCloudAttachServiceGateway:入参不填DescribeCloudAttachServiceGateways:入参不填UpdateCloudAttachServiceGateway:入参选填
CircuitNumber 否 否 String 电路编码CreateCloudAttachServiceGateway:入参必填DeleteCloudAttachServiceGateway:入参不填DescribeCloudAttachServiceGateways:入参不填UpdateCloudAttachServiceGateway:入参选填
RouteType 否 否 String 网关路由类型,静态路由或者BGP路由取值范围:static,bgpCreateCloudAttachServiceGateway:入参不填DeleteCloudAttachServiceGateway:入参不填DescribeCloudAttachServiceGateways:入参不填UpdateCloudAttachServiceGateway:入参选填
PeerIp 否 否 String 用户侧IP段信息CreateCloudAttachServiceGateway:入参不填DeleteCloudAttachServiceGateway:入参不填DescribeCloudAttachServiceGateways:入参不填UpdateCloudAttachServiceGateway:入参选填
BgpAsn 否 否 String BGP路由的ASN信息CreateCloudAttachServiceGateway:入参必填DeleteCloudAttachServiceGateway:入参不填DescribeCloudAttachServiceGateways:入参不填UpdateCloudAttachServiceGateway:入参选填
BgpKey 否 否 String BGP路由的KEY信息CreateCloudAttachServiceGateway:入参必填DeleteCloudAttachServiceGateway:入参不填DescribeCloudAttachServiceGateways:入参不填UpdateCloudAttachServiceGateway:入参选填
UniqVifId 否 否 String 高速上云专线通道实例ID。只作为出参使用
UniqVpgId 否 否 String 高速上云专线网关实例ID。只作为出参使用
Region 否 否 String 高速上云网关所属地域。CreateCloudAttachServiceGateway:入参必填DeleteCloudAttachServiceGateway:入参不填DescribeCloudAttachServiceGateways:入参不填UpdateCloudAttachServiceGateway:入参不填
BgpStatus 否 否 String BGP状态。只作为出参使用
Type 否 否 String 网关类型:cas:高速上云网关类型dcg:普通网关类型(VXLAN迁移用)CreateCloudAttachServiceGateway:入参选填DeleteCloudAttachServiceGateway:入参不填DescribeCloudAttachServiceGateways:入参不填UpdateCloudAttachServiceGateway:入参不填
Zone 否 否 String 网关所在region的zone名称CreateCloudAttachServiceGateway:入参必填DeleteCloudAttachServiceGateway:入参不填DescribeCloudAttachServiceGateways:入参不填UpdateCloudAttachServiceGateway:入参不填
AppId 否 否 String 用户AppId

DcNumberOfAR

接入点下的专线数目

被如下接口引用:

名称 必选 允许NULL 类型 描述
AccessPointId 是 否 Uint64 接入点数字ID
NumberOfDirectConnects 是 否 Uint64 接入点下的专线数目

Filter

用于条件过滤查询

被如下接口引用:DescribeAccessPoints、DescribeDirectConnectTunnels、DescribeDirectConnects

名称 必选 允许NULL 类型 描述
Name 是 否 String 需要过滤的字段。
Values 是 否 Array of String 字段的过滤值。

CloudAttachServiceGatewayPingInfo

高速上云服务网关的Ping探测参数

被如下接口引用:

名称 必选 允许NULL 类型 描述
UniqCasGwId 是 否 String 高速上云服务网关实例ID
Count 否 否 Uint64 Ping探测次数
Size 否 否 Uint64 Ping探测包的大小
Interval 否 否 Uint64 Ping探测间隔,单位毫秒
ConnPeerIp 是 否 String 需要探测的对端IP地址

TcapIpCertificate

用户cnnic IP证书信息

被如下接口引用:

名称 必选 允许NULL 类型 描述
Id 否 否 Int64 证书ID
StoragePath 是 否 String 证书存储路径
Ipv4Addresses 否 是 String 证书上的ipv4地址
Ipv6Addresses 否 是 String 证书上的ipv6地址
Asn 否 是 String 证书上的asn号
CertificateNumber 否 是 String 证书上的ID
StartDate 否 是 Date 证书生效时间
ExpireDate 否 是 Date 证书过期时间
Valid 否 是 Bool 证书是否有效

LocalIpTranslationNatRule

本端IP转换复杂类型

被如下接口引用:

名称 必选 允许NULL 类型 描述
OriginalIp 是 否 String 原始IP
TranslationIp 是 否 String 映射IP
Description 是 否 String 描述

TcapPartPriceDetail

tcap 金银铜带宽价格信息。

被如下接口引用:

名称 必选 允许NULL 类型 描述
Discount 是 否 Float 折扣
DiscountPrice 是 否 Float 折后价
OriginalPrice 是 否 Float 原价

CloudAttachInfo

高速上云服务信息

被如下接口引用:

名称 必选 允许NULL 类型 描述
InstanceId 否 否 String 高速上云实例idCreateCloudAttachService:入参不填DeleteCloudAttachService:入参必填CancelCloudAttachService:入参必填DescribeCloudAttachServices:入参选填UpdateCloudAttachService:入参必填ConfirmCloudAttachService:入参必填DeliveryCloudAttachService:入参必填
Name 否 否 String 高速上云名称CreateCloudAttachService:入参必填DeleteCloudAttachService:入参选填CancelCloudAttachService:入参不填DescribeCloudAttachServices:入参选填UpdateCloudAttachService:入参选填ConfirmCloudAttachService:入参不填DeliveryCloudAttachService:入参不填
IapId 否 否 String 合作伙伴的AppIdCreateCloudAttachService:入参不填DeleteCloudAttachService:入参不填CancelCloudAttachService:入参不填DescribeCloudAttachServices:入参不填UpdateCloudAttachService:入参不填ConfirmCloudAttachService:入参不填DeliveryCloudAttachService:入参不填
IdcAddress 否 否 String 需要接入高速上云的IDC的地址CreateCloudAttachService:入参必填DeleteCloudAttachService:入参不填CancelCloudAttachService:入参不填DescribeCloudAttachServices:入参不填UpdateCloudAttachService:入参选填ConfirmCloudAttachService:入参不填DeliveryCloudAttachService:入参不填
IdcType 否 否 String 需要接入高速上云的IDC的互联网服务提供商类型CreateCloudAttachService:入参必填DeleteCloudAttachService:入参不填CancelCloudAttachService:入参不填DescribeCloudAttachServices:入参不填UpdateCloudAttachService:入参选填ConfirmCloudAttachService:入参不填DeliveryCloudAttachService:入参不填
Bandwidth 否 否 Uint64 高速上云的带宽,单位为MBCreateCloudAttachService:入参必填DeleteCloudAttachService:入参不填CancelCloudAttachService:入参不填DescribeCloudAttachServices:入参不填UpdateCloudAttachService:入参不填ConfirmCloudAttachService:入参不填DeliveryCloudAttachService:入参不填
Telephone 否 否 String 联系电话CreateCloudAttachService:入参必填DeleteCloudAttachService:入参不填CancelCloudAttachService:入参不填DescribeCloudAttachServices:入参不填UpdateCloudAttachService:入参不填ConfirmCloudAttachService:入参不填DeliveryCloudAttachService:入参不填
Status 否 否 String 高速上云的状态CreateCloudAttachService:入参不填DeleteCloudAttachService:入参不填CancelCloudAttachService:入参不填DescribeCloudAttachServices:入参选填UpdateCloudAttachService:入参不填ConfirmCloudAttachService:入参必填DeliveryCloudAttachService:入参不填出参状态:available:就绪状态applying:申请,待审核状态pendingpay:代付款状态building:建设中状态confirming:待确认状态isolate: 隔离状态stoped:终止状态
ApplyTime 否 否 Datetime 高速上云申请的时间。只作为出参
ReadyTime 否 是 Datetime 高速上云建设完成的时间。只作为出参
ExpireTime 否 否 Datetime 高速上云过期时间。只作为出参
Remarks 否 否 String 备注信息CreateCloudAttachService:入参必填DeleteCloudAttachService:入参不填CancelCloudAttachService:入参不填DescribeCloudAttachServices:入参不填UpdateCloudAttachService:入参选填ConfirmCloudAttachService:入参不填DeliveryCloudAttachService:入参不填
RegionStatus 否 否 String 高速上云的地域状态。只作为出参出参状态:same-region:同地域cross-region:跨地域
AppId 否 否 String 用户的AppId。只作为出参

TcapVif

tcap 通道

被如下接口引用:

名称 必选 允许NULL 类型 描述
Id 否 否 Uint64 tcap通道id
InstanceId 否 否 String tcap通道实例id
VifName 否 否 String tcap通道名称
Bandwidth 否 否 Uint64 tcap通道带宽
ConnLocalIp 否 是 String 用户侧互联IP
ConnPeerIp 否 是 String 腾讯侧互联IP
RouteType 是 否 String 路由同步协议,默认bgp
BgpKey 否 是 String bgp 秘钥
BgpAsn 否 是 String bgp Asn 号
AccessPointId 否 是 Uint64 接入点ID
Status 否 否 Uint64 tcap通道状态; Enum[0, 1, 2, 5] 分别表示[ready, applying, deploying, deleted]
ApplyTime 否 否 Datetime 申请时间
ChargeOrNot 否 否 Bool 是否计费
ReadyTime 否 是 Datetime 就绪时间
PhysicalPortType 是 否 String 物理接口类型
AccessPointName 否 是 String 接入点名称:$city-$idc

AccessPointListEntry

接入点下交换机端口信息封装

被如下接口引用:

名称 必选 允许NULL 类型 描述
AccessPointId 是 否 Uint64 接入点数字ID
Region 是 否 String 地域名称
VpcRegion 是 否 String vpc所在地域代号,比如"sh"
Visible 是 否 Bool 是否对客户可见,接入点已下线时返回false
AccessPointName 是 否 String 接入点名称,调用AppId在国际站时,返回英文
Isp 是 否 Array of ISP 接入点支持的运营商列表
PhysicalPort 是 否 Array of SwitchPort 接入点云端支持的端口列表
PhysicalPortSort 是 否 Array of Uint64 接入点云端支持的端口ID列表
IdcPhysicalPortSort 是 否 Array of Uint64 接入点用户IDC侧支持的端口列表
IdcPhysicalPort 是 否 Array of SwitchPort 接入点用户IDC侧支持的端口ID列表

DirectConnectTunnel

专线通道信息列表

被如下接口引用:DescribeDirectConnectTunnels

名称 必选 允许NULL 类型 描述
DirectConnectTunnelId 是 否 String 专线通道ID
DirectConnectId 是 否 String 物理专线ID
State 是 否 String "专线通道状态AVAILABLE:就绪APPLYING:申请中ALLOCATING:配置中ALLOCATED:配置完成ALTERING:修改中DELETING:删除中DELETED:删除完成PENDING:待接受REJECTED:拒绝
DirectConnectOwnerAppId 是 否 Int64 专线的拥有者,开发商账号 ID
NetworkType 是 否 String 网络类型,分别为VPC、BMVPC、CCN VPC:私有网络 ,BMVPC:黑石网络,CCN:云联网
VpcId 是 否 String 私有网络统一 ID 或者黑石网络统一 ID
DirectConnectGatewayId 是 否 String 专线网关 ID
RouteType 是 否 String BGP :BGP路由 STATIC:静态
IdcRoutes 是 是 Array of String 用户侧网段地址
Vlan 是 否 Int64 专线通道的Vlan
CloudAddress 是 否 String 云侧互联IP
CustomerAddress 是 否 String 用户侧互联 IP
DirectConnectTunnelName 是 否 String 专线通道名称
CreatedTime 是 否 String 专线通道创建时间
Bandwidth 是 否 Int64 专线通道带宽值
NetDetectId 是 是 String 关联的网络自定义探测ID
NatType 是 是 Bool 是否为Nat通道
VpcRegion 是 是 String 通道连接的VPC所在地域
BfdState 是 是 String BFD状态:DISABLED: 关闭ENABLE: 开启UP:健康DOWN:异常
DirectConnectGatewayName 是 是 String 专线网关名称
VpcName 是 是 String VPC名称
EnableMulticast 是 是 Bool True: 开启, False: 不开启
MulticastGroups 是 是 String 通道下支持的组播组
AppId 是 否 Int64 专线通道的拥有者,开发上账号ID
LoadMode 是 否 String 通道负载均衡模式:0:None 1: LoadBalance 2: MasterSlave
ConnectSubnetMask 是 否 Uint64 互联地址掩码
DirectConnectOwnerUin 是 否 Int64 专线所有者账号UIN
BfdInterval 是 否 Uint64 bfd协议中的interval字段值
RelatedDirectConnectTunnelId 是 是 String 关联的通道ID
Comments 是 是 String 通道备注
MasterStatus 否 是 Bool 在主备模式下,通道是否为主
RegionStatus 是 是 Int64 用于判断同地域、境内跨地域、跨境
SupportBfd 是 是 Bool 是否支持bfd
DirectConnectTunnelOwnerUin 是 是 Int64 专线通道所有者账号UIN
BgpPeer 否 是 BgpPeer BgpPeer,用户侧bgp信息,包括Asn和AuthKey
IpType 否 否 String 通道IP协议类型
ShareMode 是 否 Bool 是否为共享通道
AccessPointId 是 否 String 专线接入点ID
DirectConnectName 否 否 String 物理专线名称

AccessPoint

接入点信息。

被如下接口引用:DescribeAccessPoints

名称 必选 允许NULL 类型 描述
AccessPointName 是 否 String 接入点的名称。
AccessPointId 是 否 Int64 接入点唯一ID。
State 是 否 String 接入点的状态。AVAILABLE, UNAVAILABLE
Location 是 否 String 接入点所在机房地址
LineOperator 是 否 Array of String 接入点支持的运营商列表。
AvailableBandwidthRatio 是 否 Uint64 接入点可用带宽百分比
CurrentBandwidth 是 否 Uint64 当前已使用带宽, 单位MBytes
NotifyBandwidthRatio 是 否 Uint64 带宽告警比例
TotalBandwidth 是 否 Uint64 接入点总带宽, 单位 MBytes
City 是 否 String IDC所在城市
CloudPortType 是 否 Array of String 物理专线用户侧接入端口类型,取值:100Base-T:百兆电口,1000Base-T(默认值):千兆电口,1000Base-LX:千兆单模光口(10千米),10GBase-T:万兆电口10GBase-LR:万兆单模光口(10千米),默认值,千兆单模光口(10千米)。
IdcPortType 是 否 Array of String 物理专线IDC侧接入端口类型,取值:100Base-T:百兆电口,1000Base-T(默认值):千兆电口,1000Base-LX:千兆单模光口(10千米),10GBase-T:万兆电口10GBase-LR:万兆单模光口(10千米),默认值,千兆单模光口(10千米)。
Region 是 否 String 地域

DcSwitch

专线接入交换机

被如下接口引用:

名称 必选 允许NULL 类型 描述
AccessPointId 是 否 Uint64 专线接入点ID,通过DescribeAccessPoints接口可获取接入点列表
Name 是 否 String 用户自定义交换机名称
Model 是 否 String 交换机型号
Manufacturer 是 否 String 交换机厂商,比如为 cisco, h3c, huawei 之一,其他字符串不支持
ManagementIp 是 否 String 云控制器使用的管理IP
ManagementPort 是 否 String 云控制器使用的管理端口
VTEPIP 是 否 String 专线接入交换机vxlan隧道的VTEP ip
SwitchId 是 否 String 专线接入交换机ID

DirectConnect

物理专线信息列表

被如下接口引用:DescribeDirectConnects

名称 必选 允许NULL 类型 描述
DirectConnectId 是 否 String 物理专线ID。
DirectConnectName 是 否 String 物理专线的名称。
AccessPointId 是 否 String 物理专线的接入点ID。
State 是 否 String 物理专线的状态。申请中:PENDING 申请驳回:REJECTED 建设中:ALLOCATED 已开通:AVAILABLE 删除中 :DELETING已删除:DELETED 。
CreatedTime 是 否 String 物理专线创建时间。
EnabledTime 是 否 String 物理专线的开通时间。
LineOperator 是 否 String 提供接入物理专线的运营商。ChinaTelecom:中国电信, ChinaMobile:中国移动,ChinaUnicom:中国联通, In-houseWiring:楼内线,ChinaOther:中国其他, InternationalOperator:境外其他。
Location 是 否 String 本地数据中心的地理位置。
Bandwidth 是 否 Int64 物理专线接入接口带宽,单位为Mbps。
RedundantDirectConnectId 是 否 String 冗余物理专线的ID。
CustomerName 是 否 String 物理专线申请者姓名。默认从账户体系获取。
CustomerContactMail 是 否 String 物理专线申请者联系邮箱。默认从账户体系获取。
CustomerContactNumber 是 否 String 物理专线申请者联系号码。默认从账户体系获取。
FaultReportContactPerson 是 否 String 报障联系人。
FaultReportContactNumber 是 否 String 报障联系电话。
IdcCity 是 否 String IDC所在城市
CloudPortType 是 否 String 云侧端口类型
ApplyId 是 否 Uint64 申请ID

CloudAttachGetPingTask

获取高速上云网关Ping任务列表

被如下接口引用:

名称 必选 允许NULL 类型 描述
UniqCasGwId 是 否 String 高速上云网关实例ID
TaskId 否 否 String 任务ID

RouteFilterPrefix

用户侧网段地址

被如下接口引用:

名称 必选 允许NULL 类型 描述
Cidr 否 否 String 用户侧网段地址

TcapIps

tcap用户侧的ip网段信息

被如下接口引用:

名称 必选 允许NULL 类型 描述
Id 否 否 Uint64 ID
TcapId 否 否 Uint64 对应的tcap 通道 ID
IpVersion 否 否 String 4(ipv4)或者6(ipv6)
IpAddress 是 否 String ip网段地址,多个用','分隔
Status 否 否 String 网段审核状态; 可能取值为: [auditing, valid, invalid]
ApplyTime 否 否 Datetime 创建时间
IpCertificateId 否 是 Int64 包含此网段的用户证书ID
AuditTime 否 是 Datetime ip 审核时间
TcapInstanceId 是 是 String 对应的tcap 通道 instance id
Description 否 是 String 描述信息

CloudAttachServiceGatewayPingTaskInfo

高速上云服务网关ping探测结果

被如下接口引用:

名称 必选 允许NULL 类型 描述
UniqCasGwId 是 否 String 高速上云服务网关实例ID
AddressFamily 是 否 String Ping探测IP协议类型
ConnPeerIp 是 否 String 探测的对端IP地址
Count 是 否 Uint64 探测次数
Size 是 否 Uint64 探测包大小
Interval 是 否 Uint64 探测间隔,单位为毫秒
Status 是 否 String 探测状态running:任务正在进行done:任务执行完毕error:任务执行错误
TaskId 是 否 String 探测任务ID
SuccessRatio 是 否 Uint64 Ping探测成功率
LatencyMin 是 否 String 最小延时
LatencyAvg 是 否 String 平均延时
LatencyMax 是 否 String 最大延时
CreateTime 是 否 Datetime 任务开始时间
EndTime 是 否 Datetime 任务结束时间

BgpPeer

bgp参数,包括Asn,AuthKey

被如下接口引用:CreateDirectConnectTunnel、DescribeDirectConnectTunnels、ModifyDirectConnectTunnelAttribute

名称 必选 允许NULL 类型 描述
Asn 否 否 Int64 用户侧,BGP Asn
AuthKey 否 否 String 用户侧BGP密钥

Tag

标签键值对

被如下接口引用:

名称 必选 允许NULL 类型 描述
Key 是 是 String 标签键
Value 是 是 String 标签值

TcapUnchargeWhiteList

tcap 计费白名单

被如下接口引用:

名称 必选 允许NULL 类型 描述
Id 是 否 Int64 白名单ID
CreateTime 是 否 Datetime 白名单创建时间

ISP

接入点支持运营商信息描述

被如下接口引用:

名称 必选 允许NULL 类型 描述
IspId 是 否 Uint64 ISP数字ID
IspName 是 否 String ISP名称,国际站AppId返回英文

SwitchPort

交换机支持的端口类型

被如下接口引用:

名称 必选 允许NULL 类型 描述
PortId 是 否 Uint64 端口数字ID
PortName 是 否 String 端口名称

CloudAttachPriceInfo

高速上云服务计费信息

被如下接口引用:

名称 必选 允许NULL 类型 描述
Discount 否 否 String 折扣
DiscountPrice 否 否 String 折后价
OriginalPrice 否 否 String 原价

InquiryCloudAttach

高速上云询价参数

被如下接口引用:

名称 必选 允许NULL 类型 描述
InstanceId 是 否 String 高速上云实例ID
TimeSpan 是 否 Uint64 询价购买月数
Type 是 否 String 询价类型:新购create,续费renew

TcapPriceDetail

tcap 价格信息

被如下接口引用:

名称 必选 允许NULL 类型 描述
BwBronze 是 否 TcapPartPriceDetail 铜牌流量价格信息
BwSilver 是 否 TcapPartPriceDetail 银牌流量价格信息
BwGolden 是 否 TcapPartPriceDetail 金牌流量价格信息