Doc CenterSign in to zenConsole

Data Types

PortInfo

Basic information on a port, including port name, business entity name, data center, and etc.

Parameter Name
Type
Description

portId

String

Port ID.

portName

String

Port name.

portRemarks

String

Port Description.

portType

String

Port speed. Value range: 1G/10G/40G

connectionStatus

ConnectionStatus

Network connectivity state.

portStatus

PortStatus

Port state.

dcId

String

Data center ID

dcName

String

Data center name.

cityName

String

City name.

areaName

String

Region name.

loaStatus

LOAStatus

LOA state.

loaDownloadUrl

String

LOA URL address.

createdTime

Timestamp

Creation time.

Use UTC time according to the ISO8601 standard. Format: YYYY-MM-DDThh:mm:ssZ.

expiredTime

Timestamp

Expiration time.

Use UTC time according to the ISO8601 standard. Format: YYYY-MM-DDThh:mm:ssZ.

portChargeType

String

Port pricing model.

PREPAID: monthly subscription.

POSTPAID: pay-as-you-go.

period

Integer

Period of port subscription.

Unit: month.

For postpaid instances, the value is empty.

businessEntityName

String

Business entity name.

The entity name to be used on the Letter of Authorization (LOA). This should be the name that is registered with the colocation facility.

ConnectionStatus

Network connectivity state.

State
Description

ACTIVE

The network is connected.

DOWN

The network is not connected.

PortStatus

Port state.

State
Description

CREATING

Creating.

UPDATING

Updating.

DELETING

Deleting.

DESTROYING

Releasing.

RECOVERING

Restoring.

RUNNING

Running.

RECYCLED

Recycled.

DESTROYED

Released.

PortPrice

Port speed and price.

Parameter Name
Type
Description

dcId

String

Data center ID, such as SIN1.

portType

String

Port speed. Value range: 1G/10G/40G

portDailyPrice

Float

Daily price of a port.

portMonthlyPrice

Float

Monthly price of a port.

LOAStatus

LOA state.

State
Description

LOA_NOT_UPLOAD

Not uploaded.

LOA_UPLOADED

Uploaded.

PortTrafficInfo

Port bandwidth information.

Parameter Name
Type
Description

unit

String

Bandwidth unit: bps.

records

Array of TrafficData

Details of bandwidth.

inMax

Double

Maximum value of inbound bandwidth.

inMin

Double

Minimum value of inbound bandwidth.

inAvg

Double

Average value of inbound bandwidth.

outMax

Double

Maximum value of outbound bandwidth.

outMin

Double

Minimum value of outbound bandwidth.

outAvg

Double

Average value of outbound bandwidth.

DatacenterInfo

Information on a data center.

Parameter Name
Type
Description

dcId

String

Code of a data center, consisting of an IATA airport code and a number.

dcName

String

Data center name.

dcAddress

String

Data center location.

cityName

String

City name.

countryName

String

Country name.

areaName

String

Region name.

isPortAvailable

Boolean

Whether port creation is supported or not. Only takes a value in DescribeDatacenters

PrivateConnect

Information on a Layer 2 private connect, including ID, connectivity, access point A and access point Z.

Parameter Name
Type
Description

privateConnectId

String

Private connect ID.

privateConnectName

String

Private connect name.

connectivityStatus

String

Network connectivity state. See ConnectionStatus for more details.

endpointA

PrivateConnectEndpoint

Basic information of access point A.

endpointZ

PrivateConnectEndpoint

Basic information of access point Z.

privateConnectStatus

String

Private connect state. See PrivateConnectStatus for more details.

bandwidthMbps

Long

Maximum bandwidth cap limit of a private connect.

resourceGroupId

String

Resource group ID.

resourceGroupName

String

Resource group name.

createTime

Timestamp

Creation time.

expiredTime

Timestamp

Expiration time. This parameter is only valid for subscription resources.

recycledTime

Timestamp

Recycled time.

PrivateConnectEndpoint

Basic information on access points in a private connect.

Parameter Name
Type
Description

endpointId

String

Access point ID.

endpointName

String

Access point name.

endpointType

String

Access point type.

dataCenter

DataCenterInfo

Information on data center to which the access point belongs.

vlanId

Integer

Access point VLAN ID. Value range: from 1 to 4096.

connectivityStatus

ConnectionStatus

Connectivity state of an access point.

PrivateConnectStatus

State of a private connect.

State
Description

DEPLOYING

Deploying.

UPDATING

Updating.

DELETING

Deleting.

DESTROYING

Releasing.

RECOVERING

Recovering.

RUNNING

Running.

RECYCLED

Recycled.

CloudRouterStatus

State of a cloud router.

State
Description

DEPLOYING

Deploying.

UPDATING

Updating.

DELETING

Deleting.

DESTROYING

Releasing.

RECOVERING

Recovering.

RUNNING

Running.

RECYCLED

Recycled.

CreateEndpointParam

Create access point information, including types of ports, AWS, Google, and Tencent with different detailed information.

PortEndpointParam

Information on a data center port as an endpoint.

Parameter Name
Type
Required
Description

portId

String

Yes

Data center port ID.

vlanId

Integer

Yes

VLAN ID. Call DescribePortUsableVlan to query available VLAN ID for a specified port.

CloudEndpointParam

Information on a public cloud (Tencent/AWS/Google/AliCloud/Azure) as an endpoint.

Parameter Name
Type
Required
Description

cloudAccountId

String

Yes

Cloud account ID. For Google Cloud, pass the value of Pairing Key. See Google Cloud Configuration for more details.

cloudType

String

Yes

Public cloud type. Available value:

  • AWS

  • TENCENT

  • GOOGLE

  • ALI_CLOUD

  • AZURE

cloudRegionId

String

No

Available location ID for public cloud. The value is not required for Google Cloud.

dcId

String

Yes

Data center ID to connect to public cloud.

vlanId

Integer

Yes.

VLAN ID. The value is empty when cloudType is ALI_CLOUD.

TrafficData

Information on bandwidth.

Parameter Name
Type
Description

internetRX

Integer

Inbound bandwidth. Unit: bps.

internetTX

Integer

Outbound bandwidth. Unit: bps.

time

Timestamp

Data time.

Time format: YYYY-MM-DDThh:mm:ssZ.

EndpointType

Access point types in a private connect

Type
Description

SUBNET

Subnet.

GOOGLE

Google Cloud.

TENCENT

Tencent Cloud.

AWS

AWS Cloud.

PORT

Dedicated port.

OTHER_PORT

Shared port.

Price

Describe price information of subscription and pay-as-you-go resources.

Parameter Name
Type
Description

originalPrice

Float

Original price of subscription resources.

Only used in subscription model. For pay-as-you-go model, the value is empty.

discountPrice

Float

Discount price of subscription resources.

Only used in subscription model. For pay-as-you-go model, the value is empty.

discount

Float

Discount. For example, 80.0 means 20% off.

unitPrice

Float

Original unit price of pay-as-you-go resources.

Only used in pay-as-you-go model. For tiered billing, the value is empty.

discountUnitPrice

Float

Discount unit price of pay-as-you-go resources.

Only used in pay-as-you-go model. For tiered billing, the value is empty.

chargeUnit

String

Unit of pay-as-you-go billing. Only used in pay-as-you-go model.

Value range: HOUR: you will be billed by hour. DAY: you will be billed by day. MONTH: you will be billed by month. For example, the burstable 95th pricing model.

stepPrices

Array of StepPrice

Tiered price of pay-as-you-go billing. Only used in pay-as-you-go model. If it is not tiered price, the value is empty.

StepPrice

Tiered price of pay-as-you-go billing. Describe a tier of the price.

Parameter Name
Type
Description

stepStart

Float

First price range of a tiered price.

stepEnd

Float

Last price range of a tiered price.

unitPrice

Float

Original unit price of current price range. Only used in pay-as-you-go model.

discountUnitPrice

Float

Discount unit price of current price range. Only used in pay-as-you-go model.

CreateCloudRouterEdgePoint

Information on creating access points in a cloud router, including types of ports, VPCs, AWS, Google, and Tencent with different detailed information.

CreateVpcEdgePoint

Information on creating a VPC access point in a cloud router.

Parameter Name
Type
Required
Description

vpcId

String

Yes

VPC ID related to bare metal. You can call DescribeCloudRouterAvailableVpcs to obtain available VPCs. A VPC can only be added into one cloud router.

bandwidthMbps

Integer

No

Access bandwidth of the access point.

Unit: Mbps. The value is 1 by default.

CreateDcPortEdgePoint

Information on creating a port access point in a cloud router.

Parameter Name
Type
Required
Description

portId

String

Yes

Port ID. You can call DescribeCloudRouterAvailablePorts to obtain available ports.

vlanId

Integer

Yes

VLAN ID. You can call DescribePortUsableVlan to obtain available VLANs. VLAN range: from 2 to 4000

ipAddress

String

Yes

IP address.

bandwidthMbps

Integer

No

Access bandwidth of the access point.

Unit: Mbps. The value is 1 by default.

bgpConnection

BGPConnection

No

BGP routing. One of BGP and Static routing must be specified.

staticRoutes

Array of IpRoute

No

Static routing. One of BGP and Static routing must be specified.

CreateCloudEdgePoint

Information on creating a public cloud access point (AWS/Tencent/Google/AliCloud/Azure) in a cloud router.

Parameter Name
Type
Required
Description

cloudType

String

Yes

Public cloud type. Available value:

  • AWS

  • TENCENT

  • GOOGLE

  • ALI_CLOUD

  • AZURE

cloudAccountId

String

Yes

Cloud account ID. For Google Cloud, pass the value of Pairing Key. See Google Cloud Configuration for more details.

edgePointName

String

No

Access point name. The length should be 1 to 255 characters.

cloudRegionId

String

No

Available location ID for public cloud. The value is not required for Google Cloud.

dcId

String

Yes

Data center ID to connect to public cloud.

vlanId

Integer

Yes

VLAN ID. You can call DescribeAWSVlanUsage, DescribeTencentVlanUsage, DescribeGoogleVlanUsage to obtain available VLANs. VLAN range: from 2 to 4000 The value is empty when cloudType is ALI_CLOUD.

ipAddress

String

Yes

IP address.

bandwidthMbps

Integer

No

Access bandwidth of the access point.

Unit: Mbps. The value is 1 by default.

bgpConnection

BGPConnection

No

BGP routing. One of BGP and Static routing must be specified.

staticRoutes

Array of IpRoute

No

Static routing. One of BGP and Static routing must be specified.

BGPConnection

BGP routing configurations.

Parameter Name
Type
Required
Description

peerIpAddress

String

Yes

BGP peering IP address.

peerAsn

Integer

Yes

Peer BGP ASN. An integer ranges from 1 to 4294967294.

localAsn

Integer

No

On-premise BGP ASN. An integer ranges from 1 to 4294967294. The value is 62610 and cannot be changed while configuring ports, Tencent Cloud, Google Cloud and AWS access points.

password

String

No

BGP authentication key.

At most 32 characters are allowed.

IPRoute

Static routing configurations.

Parameter Name
Type
Required
Description

prefix

String

Yes

IPv4 prefix used for routing to the next hop.

nextHop

String

No

Next hop IPv4 address. The value is needed while configuring ports, Tencent Cloud, Google Cloud and AWS access points.

CloudRouter

Information on Layer 3 cloud router.

Parameter Name
Type
Description

cloudRouterId

String

Cloud router ID.

cloudRouterName

Integer

Cloud router name.

cloudRouterDescription

String

Cloud router description.

edgePoints

Array of CloudRouterEdgePoint

Access points in a cloud router.

cloudRouterChargeType

String

Cloud router pricing model.

  • PREPAID: monthly subscription.

  • POSTPAID: pay-as-you-go.

createTime

Timestamp

Creation time.

expiredTime

Timestamp

Expiration time.

This parameter is only valid for subscription resources.

recycledTime

Timestamp

Released time.

After a cloud router is deleted, it will be released at the released time.

period

Integer

Subscription term.

Unit: calendar month.

This parameter is only valid for subscription resources.

cloudRouterStatus

CloudRouterStatus

Cloud router state.

connectivityStatus

String

Cloud router connectivity.

resourceGroupId

String

Resource group ID.

resourceGroupName

String

Resource group name.

CloudRouterEdgePoint

Information on access points in a cloud router.

Parameter Name
Type
Description

edgePointId

String

Access point ID.

edgePointName

String

Access point name.

connectivityStatus

String

Access point state.

dataCenter

DataCenterInfo

Data center information of the access point.

ipAddress

String

IP address.

edgePointType

String

Access point type. Available value:

  • VPC: VPC

  • PORT: physical port (dedicated)

  • OTHER_PORT: physical port (shared)

  • GOOGLE: Google Cloud

  • TENCENT: Tencent Cloud

  • AWS: AWS

  • ALI_CLOUD: Aliyun

  • AZURE: Azure

  • VIRTUAL_EDGE: IP Sec

vpcId

String

VPC ID. This parameter is only valid when access point type is VPC.

portId

String

Port ID This parameter is only valid when access point type is PORT.

cloudRegionId

String

Available location ID for public cloud.

This parameter is only valid when access point type is GOOGLE, TENCENT ,ALI_CLOUDor AWS.

cloudAccountId

String

Cloud account ID.

vlanId

Integer

Access point VLAN ID.

bandwidthMbps

Integer

Access bandwidth of the access point.

Unit: Mbps.

bgpConnection

BGPConnection

BGP routing information.

staticRoutes

Array of IPRoute

Static routing information.

createTime

Timestamp

Creation time.

CloudRouterAvailableVpc

Information on VPCs in a Layer 3 cloud router.

Parameter Name
Type
Description

vpcId

String

VPC ID.

vpcName

String

VPC name.

dataCenter

DataCenterInfo

Data center of VPC.

cidrBlock

String

CIDR block of VPC.

CloudRegion

Location information of public cloud access point.

Parameter Name
Type
Description

cloudRegionId

String

Available location ID for public cloud.

dataCenter

DataCenterInfo

Data center information of cloud access point.

products

Array of String

Supported products at the location Available value:

  • PrivateConnect: Layer 2 Private Connect

  • CloudRouter: Layer 3 Cloud Router

Last updated