DirectConnect
Physical Leased Line Information List
Referenced by the following interfaces: DescribeDirectConnects
| name | required | NULL allowed | type | description |
|---|---|---|---|---|
| DirectConnectId | yes | no | String | Physical DC ID Example: dc-psjiehij |
| DirectConnectName | yes | no | String | Physical DC Name Example: mock_dc |
| AccessPointId | yes | no | String | Access Point ID of Physical DC Example: ap-place-c-jxq |
| State | yes | no | String | Physical DC Status Applying: PENDING Application rejected: REJECTED Under construction: ALLOCATED Activated: AVAILABLE Deleting: DELETING Deleted: DELETED. Example: PENDINGPAY |
| CreatedTime | yes | no | String | Creation Time For Physical DC Example: 2020-12-08 16:57:43 |
| EnabledTime | yes | no | String | Enablement Time for Physical DC Example: 2021-01-06 10:39:41 |
| LineOperator | yes | no | String | ISPs providing access connection. Telecom: CTCC; Mobile: CMCC; Unicom: CUCC; In-houseWiring: in-house wiring; Other: others; InternationalOperator: others mainland. Example: In-houseWiring |
| Location | yes | no | String | Geographical Location of Local Data Center Example: UK |
| Bandwidth | yes | no | Int64 | Physical DC interface bandwidth, in a unit of Mbps. Example: 1000 |
| RedundantDirectConnectId | yes | no | String | Redundant Physical DC ID Example: dc-1234 |
| CustomerName | yes | no | String | Name of physical DC applicant, obtained from account system by default. Example: Tom |
| CustomerContactMail | yes | no | String | E-mail address of physical DC applicant, obtained from account system by default. Example: 274907341@mail.com |
| CustomerContactNumber | yes | no | String | Contact number of physical DC applicant, obtained from account system by default. Example: 15802738654 |
| FaultReportContactPerson | yes | no | String | Fault Contact Example: Tom |
| FaultReportContactNumber | yes | yes | String | Fault Reporting Contact Number Example: 15802738654 |
| IdcCity | yes | no | String | City Where IDC Locates Example: place |
| CloudPortType | yes | no | String | Cloud Side Port Type Example: 100Base-T |
| ApplyId | yes | no | Uint64 | Application ID Example: 130000000301 |
| IsShare | no | no | Bool | Whether to Share Example: True |
| DcOwnerUin | no | no | String | DC Provider Account Example: 130000000301 |
| TunnelCount | no | no | Uint64 | Private Channel Quantity Example: 100 |
| AppId | no | no | Uint64 | DC AppId Example: 130000000301 |
DirectConnectTunnel
Private Channel Information List
Referenced by the following interfaces: DescribeDirectConnectTunnels
| name | required | NULL allowed | type | description |
|---|---|---|---|---|
| DirectConnectTunnelId | yes | no | String | Private Channel ID Example: dcx-r3sml04o |
| DirectConnectId | yes | no | String | Connection ID Example: dc-9s5kpgyp |
| State | yes | no | String | Private Channel Status AVAILABLE: Ready APPLYING: Applying ALLOCATING: Configuration in progress ALLOCATED: Configuration completed ALTERING: Modifying DELETING: Deleting DELETED: Deletion completed PENDING: Pending acceptance REJECTED: Rejected Example: PENDING |
| DirectConnectOwnerAppId | yes | no | Int64 | DC owner, developer account ID. Example: 130000000301 |
| NetworkType | yes | no | String | Network type. VPC: Virtual Private Cloud. Example: VPC |
| VpcId | yes | no | String | Unified VPC ID. Example: vpc-aipqhdez |
| DirectConnectGatewayId | yes | no | String | Direct connect gateway ID Example: dcg-r70hz833 |
| RouteType | yes | no | String | BGP: BGP routing; STATIC: Static. Example: STATIC |
| IdcRoutes | yes | yes | Array of String | User-Side Network Segment Address Example: 10.0.0.0/16 |
| Vlan | yes | no | Int64 | VLAN of Private Channel Example: 100 |
| CloudAddress | yes | no | String | Cloud-Side Interconnect IP Example: 10.10.10.10 |
| CustomerAddress | yes | no | String | User-Side Interconnect IP Example: 169.254.64.2/29 |
| DirectConnectTunnelName | yes | no | String | Private Channel Name Example: dc_name |
| CreatedTime | yes | no | String | Private Channel Creation Time Example: 2018-06-01 14:59:16 |
| Bandwidth | yes | no | Int64 | Bandwidth Value of Private Channel Example: 1000 |
| NetDetectId | yes | yes | String | Associated Network Custom Probe ID Example: 100 |
| NatType | yes | yes | Bool | Whether it is a Nat channel. Example: True |
| VpcRegion | yes | yes | String | Region Where VPC Connected by Channel Locates Example: gz |
| BfdState | yes | yes | String | BFD status: DISABLED: Off ENABLE: On UP: Healthy DOWN: Abnormal Example: 0 |
| DirectConnectGatewayName | yes | yes | String | Direct Connect Gateway Name Example: Test gateway. |
| VpcName | yes | yes | String | VPC Name Example: Test VPC. |
| EnableMulticast | yes | yes | Bool | True: Enabled; False: Disabled. Example: True |
| MulticastGroups | yes | yes | String | Multicast Group Supported Under Channel Example: 224.0.2.2 |
| AppId | yes | no | Int64 | Private channel owner, developer account ID. Example: 130000000301 |
| LoadMode | yes | no | String | Channel CLB modes: 0: None; 1: LoadBalance; and 2: MasterSlave. Example: LoadBalance |
| ConnectSubnetMask | yes | no | Uint64 | Interconnection Address Mask Example: 16 |
| DirectConnectOwnerUin | yes | no | Int64 | Leased Line Owner Account UIN Example: 130000000301 |
| BfdInterval | yes | no | Uint64 | Interval Field Value in BFD Protocol Example: 100 |
| RelatedDirectConnectTunnelId | yes | yes | String | Associated Channel ID Example: dcx-2j1x1udk |
| Comments | yes | yes | String | Channel Remarks Example: Comments |
| MasterStatus | no | yes | Bool | In a primary/secondary mode, whether the channel is primary. Example: True |
| RegionStatus | yes | yes | Int64 | Used for determining same region, across regions within mainland, cross-border Example: 0 |
| SupportBfd | yes | yes | Bool | Whether to Support BFD Example: True |
| DirectConnectTunnelOwnerUin | yes | yes | Int64 | Private Channel Owner Account UIN Example: 130000000301 |
| BgpPeer | no | yes | BgpPeer | BgpPeer, user-side BGP information, including ASN and AuthKey. Example:View |
| IpType | no | no | String | Channel IP Protocol Type Example: v4 |
| ShareMode | yes | no | Bool | Whether it is a shared channel. Example: True |
| AccessPointId | yes | no | String | DC Point ID Example: 100 |
| DirectConnectName | no | no | String | Physical Leased Line Name Example: dc-dfas |
Filter
Used for conditional filtering queries.
Referenced by the following interfaces: DescribeAccessPoints, DescribeDirectConnectTunnels, DescribeDirectConnects
| name | required | NULL allowed | type | description |
|---|---|---|---|---|
| Name | yes | no | String | Field Needing To Be Filtered Example: Name |
| Values | yes | no | Array of String | Filter Value of Field Example: mock_name |
AccessPoint
Access Point Information
Referenced by the following interfaces: DescribeAccessPoints
| name | required | NULL allowed | type | description |
|---|---|---|---|---|
| AccessPointName | yes | no | String | Access Point Name Example: Central-A-West Region |
| AccessPointId | yes | no | Int64 | Unique ID of Access Point Example: 100 |
| State | yes | no | String | Access point status: AVAILABLE and UNAVAILABLE. Example: AVAILABLE |
| Location | yes | no | String | Address of Data Center Where Access Point Locates Example: Central Telecom West Region 803DC |
| LineOperator | yes | no | Array of String | List of Access Point Supported ISPs Example: ["Telecom"] |
| AvailableBandwidthRatio | yes | no | Uint64 | Bandwidth Percentage Available for Access Point Example: 100 |
| CurrentBandwidth | yes | no | Uint64 | Current used bandwidth, unit: MBytes. Example: 100 |
| NotifyBandwidthRatio | yes | no | Uint64 | Bandwidth Alarm Ratio Example: 100 |
| TotalBandwidth | yes | no | Uint64 | Total bandwidth of access points, unit: MBytes. Example: 100 |
| City | yes | no | String | City Where IDC Locates Example: place |
| CloudPortType | yes | no | Array of String | User-side access port type of the physical DC, values: 100 Base-T: Fast Ethernet, 1000 Base-T (default value): Gigabit Ethernet, 1000 Base-LX: Gigabit Single-Mode Fiber (10 km), 10 GBase-T: 10 Gigabit Ethernet 10 GBase-LR: 10 Gigabit Single-Mode Fiber (10 km), default value, Gigabit Single-Mode Fiber (10 km). Example: 100Base-T |
| IdcPortType | yes | no | Array of String | Physical DC IDC side access port type, values: 100 Base-T: Fast Ethernet, 1000 Base-T (default value): Gigabit Ethernet, 1000 Base-LX: Gigabit single-mode fiber (10 km), 10 GBase-T: 10 Gigabit Ethernet 10 GBase-LR: 10 Gigabit single-mode fiber (10 km), default value, Gigabit single-mode fiber (10 km). Example: 100Base-T |
| Region | yes | no | String | Region Example: 50001000 |
IspInfo
ISP details
Referenced by the following interfaces: DescribeIsp
| name | required | NULL allowed | type | description |
|---|---|---|---|---|
| IspId | no | no | Int64 | ISP ID Example: 100 |
| IspName | no | no | String | ISP Other name Example: place |
| IspInternationalName | no | no | String | ISP English name Example: place |
BgpPeer
BGP Parameters, including ASN, AuthKey.
Referenced by the following interfaces: CreateDirectConnectTunnel, DescribeDirectConnectTunnels, ModifyDirectConnectTunnelAttribute
| name | required | NULL allowed | type | description |
|---|---|---|---|---|
| Asn | no | no | Int64 | User side, BGP ASN. Example: 100 |
| AuthKey | no | no | String | User-Side BGP Key Example: bgp_key |