Data Types
PortInfo
Basic information on a port, including port name, business entity name, data center, and etc.
portId
String
Port ID.
portName
String
Port name.
portRemarks
String
Port Description.
portType
String
Port speed. Value range: 1G/10G/40G
dcId
String
Data center ID
dcName
String
Data center name.
cityName
String
City name.
areaName
String
Region name.
loaDownloadUrl
String
LOA URL address.
createdTime
Creation time.
Use UTC time according to the ISO8601 standard. Format: YYYY-MM-DDThh:mm:ssZ
.
expiredTime
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.
ACTIVE
The network is connected.
DOWN
The network is not connected.
PortStatus
Port state.
CREATING
Creating.
UPDATING
Updating.
DELETING
Deleting.
DESTROYING
Releasing.
RECOVERING
Restoring.
RUNNING
Running.
RECYCLED
Recycled.
DESTROYED
Released.
PortPrice
Port speed and price.
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.
LOA_NOT_UPLOAD
Not uploaded.
LOA_UPLOADED
Uploaded.
PortTrafficInfo
Port bandwidth information.
unit
String
Bandwidth unit: bps.
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.
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.
privateConnectId
String
Private connect ID.
privateConnectName
String
Private connect name.
bandwidthMbps
Long
Maximum bandwidth cap limit of a private connect.
resourceGroupId
String
Resource group ID.
resourceGroupName
String
Resource group name.
PrivateConnectEndpoint
Basic information on access points in a private connect.
endpointId
String
Access point ID.
endpointName
String
Access point name.
endpointType
String
Access point type.
vlanId
Integer
Access point VLAN ID. Value range: from 1 to 4096.
PrivateConnectStatus
State of a private connect.
DEPLOYING
Deploying.
UPDATING
Updating.
DELETING
Deleting.
DESTROYING
Releasing.
RECOVERING
Recovering.
RUNNING
Running.
RECYCLED
Recycled.
CloudRouterStatus
State of a cloud router.
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.
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.
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.
internetRX
Integer
Inbound bandwidth. Unit: bps.
internetTX
Integer
Outbound bandwidth. Unit: bps.
EndpointType
Access point types in a private connect
SUBNET
Subnet.
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.
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.
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.
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.
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.
CreateCloudEdgePoint
Information on creating a public cloud access point (AWS/Tencent/Google/AliCloud/Azure) in a cloud router.
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
BGP routing configurations.
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.
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.
cloudRouterId
String
Cloud router ID.
cloudRouterName
Integer
Cloud router name.
cloudRouterDescription
String
Cloud router description.
cloudRouterChargeType
String
Cloud router pricing model.
PREPAID: monthly subscription.
POSTPAID: pay-as-you-go.
recycledTime
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.
connectivityStatus
String
Cloud router connectivity.
resourceGroupId
String
Resource group ID.
resourceGroupName
String
Resource group name.
CloudRouterEdgePoint
Information on access points in a cloud router.
edgePointId
String
Access point ID.
edgePointName
String
Access point name.
connectivityStatus
String
Access point state.
ipAddress
String
IP address.
edgePointType
String
Access point type. Available value:
VPC
: VPCPORT
: physical port (dedicated)OTHER_PORT: physical port (shared)
GOOGLE
: Google CloudTENCENT
: Tencent CloudAWS
: AWSALI_CLOUD
: AliyunAZURE
: AzureVIRTUAL_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_CLOUD
or AWS
.
cloudAccountId
String
Cloud account ID.
vlanId
Integer
Access point VLAN ID.
bandwidthMbps
Integer
Access bandwidth of the access point.
Unit: Mbps.
CloudRouterAvailableVpc
Information on VPCs in a Layer 3 cloud router.
vpcId
String
VPC ID.
vpcName
String
VPC name.
cidrBlock
String
CIDR block of VPC.
CloudRegion
Location information of public cloud access point.
cloudRegionId
String
Available location ID for public cloud.
products
Array of String
Supported products at the location Available value:
PrivateConnect
: Layer 2 Private ConnectCloudRouter
: Layer 3 Cloud Router
Last updated