Appendix

CSN

  • API Reference
    • API function release records
    • Appendix
    • Bandwidth Package Related
      • Bandwidth package price inquiry
      • Bandwidth upgrade-downgrade for the bandwidth package
      • Bind a bandwidth package to a Cloud Smart Network
      • Create bandwidth package
      • Delete bandwidth package
      • Query bandwidth package list
      • Query the specified bandwidth package details
      • Unbind a bandwidth package from a Cloud Smart Network
      • Update bandwidth package
    • Cloud Smart Network Related
      • Create a Cloud Smart Network
      • Delete a Cloud Smart Network
      • Network instances loaded by the Cloud Smart Network
      • Network instances unloaded by the Cloud Smart Network
      • Query Cloud Smart Network details
      • Query Cloud Smart Network instance list
      • Query the list of Cloud Smart Network
      • Update a Cloud Smart Network
    • Common Headers and Error Responses
    • General Description
    • Ingress Management Related Interfaces
      • Add a routing entry
      • Create affiliation
      • Create learning relationship
      • Delete a learning relationship
      • Delete a routing entry
      • Delete an association relationship
      • Query association relationships
      • Query learning relationships
      • Query route table list
      • Query routing entries
    • Interface Overview
    • Region Bandwidth Related Interfaces
      • Create cross-region bandwidth
      • Delete cross-region bandwidth
      • Query cross-region bandwidth
      • Query the cross-region bandwidth of the specified Cloud Smart Network
      • Update cross-region bandwidth
    • Service domain
    • TGW Related Interfaces
      • Query routing entries of a TGW
      • Query TGW list
      • Update TGW information
  • FAQs
    • Consultation
  • Function Release Records
  • Operation guide
    • Cross-Account Authorization Management
      • Cancel Authorized Network Instance
      • Create Authorized Network Instance
      • Delete Authorized Network Instance
      • View Authorized Network Instance
    • Cross-Region Bandwidth Package Management
    • CSN Instance
      • Create CSN Instance
      • Delete CSN Instance
      • Modify CSN Instance
    • Identity and access management
    • Monitor and Operations
      • CSN Instance Diagnosis
    • Network instance
      • Add Cross-Account Network Instance
      • Add Local Account Network Instance
      • Adjust Network Instance Bandwidth
      • Uninstall Network Instance
    • Region Bandwidth Management
      • Adjust Region Bandwidth
      • Create cross-region bandwidth
      • Delete cross-region bandwidth
    • Route management
      • Association Relationship
        • Create affiliation
        • Delete affiliation
      • Custom route tables
        • Create custom route table
        • Delete custom route table
        • View Custom Route Table
      • Learning Relationship
        • Add Custom Route Entry
        • Create learning relationship
        • Delete Custom Route Entry
        • Delete learning relationship
        • Publish and Revoke Network Instance Route
        • View Route Entry
    • Tag Management
  • Product Description
    • Application scenarios
    • Introduction
    • Usage restrictions
  • Product pricing
  • SDK
    • GO-SDK
      • Bandwidth package
      • CSN Instance
      • Exception handling
      • Initialization
      • Install
      • Overview
      • Region Bandwidth
      • Route management
      • TGW
    • Java-SDK
      • CSN
      • Exception handling
      • Initialization
      • Install the SDK Package
      • Overview
      • Version history
    • Python-SDK
      • Bandwidth package
      • CSN Instance
      • Initialization
      • Region Bandwidth
      • Route management
      • TGW
  • Service Level Agreement (SLA)
    • Cloud Smart Network Service Level Agreement SLA
  • Typical Practices
    • CSN supports VPC custom route tables for secure traffic access
    • Multi-IDC Disaster Recovery via Cloud Smart Network
    • Multi-IDC Interconnection via Cloud Smart Network
    • Private Network VPC Interconnection with Edge Network
All documents
menu
No results found, please re-enter

CSN

  • API Reference
    • API function release records
    • Appendix
    • Bandwidth Package Related
      • Bandwidth package price inquiry
      • Bandwidth upgrade-downgrade for the bandwidth package
      • Bind a bandwidth package to a Cloud Smart Network
      • Create bandwidth package
      • Delete bandwidth package
      • Query bandwidth package list
      • Query the specified bandwidth package details
      • Unbind a bandwidth package from a Cloud Smart Network
      • Update bandwidth package
    • Cloud Smart Network Related
      • Create a Cloud Smart Network
      • Delete a Cloud Smart Network
      • Network instances loaded by the Cloud Smart Network
      • Network instances unloaded by the Cloud Smart Network
      • Query Cloud Smart Network details
      • Query Cloud Smart Network instance list
      • Query the list of Cloud Smart Network
      • Update a Cloud Smart Network
    • Common Headers and Error Responses
    • General Description
    • Ingress Management Related Interfaces
      • Add a routing entry
      • Create affiliation
      • Create learning relationship
      • Delete a learning relationship
      • Delete a routing entry
      • Delete an association relationship
      • Query association relationships
      • Query learning relationships
      • Query route table list
      • Query routing entries
    • Interface Overview
    • Region Bandwidth Related Interfaces
      • Create cross-region bandwidth
      • Delete cross-region bandwidth
      • Query cross-region bandwidth
      • Query the cross-region bandwidth of the specified Cloud Smart Network
      • Update cross-region bandwidth
    • Service domain
    • TGW Related Interfaces
      • Query routing entries of a TGW
      • Query TGW list
      • Update TGW information
  • FAQs
    • Consultation
  • Function Release Records
  • Operation guide
    • Cross-Account Authorization Management
      • Cancel Authorized Network Instance
      • Create Authorized Network Instance
      • Delete Authorized Network Instance
      • View Authorized Network Instance
    • Cross-Region Bandwidth Package Management
    • CSN Instance
      • Create CSN Instance
      • Delete CSN Instance
      • Modify CSN Instance
    • Identity and access management
    • Monitor and Operations
      • CSN Instance Diagnosis
    • Network instance
      • Add Cross-Account Network Instance
      • Add Local Account Network Instance
      • Adjust Network Instance Bandwidth
      • Uninstall Network Instance
    • Region Bandwidth Management
      • Adjust Region Bandwidth
      • Create cross-region bandwidth
      • Delete cross-region bandwidth
    • Route management
      • Association Relationship
        • Create affiliation
        • Delete affiliation
      • Custom route tables
        • Create custom route table
        • Delete custom route table
        • View Custom Route Table
      • Learning Relationship
        • Add Custom Route Entry
        • Create learning relationship
        • Delete Custom Route Entry
        • Delete learning relationship
        • Publish and Revoke Network Instance Route
        • View Route Entry
    • Tag Management
  • Product Description
    • Application scenarios
    • Introduction
    • Usage restrictions
  • Product pricing
  • SDK
    • GO-SDK
      • Bandwidth package
      • CSN Instance
      • Exception handling
      • Initialization
      • Install
      • Overview
      • Region Bandwidth
      • Route management
      • TGW
    • Java-SDK
      • CSN
      • Exception handling
      • Initialization
      • Install the SDK Package
      • Overview
      • Version history
    • Python-SDK
      • Bandwidth package
      • CSN Instance
      • Initialization
      • Region Bandwidth
      • Route management
      • TGW
  • Service Level Agreement (SLA)
    • Cloud Smart Network Service Level Agreement SLA
  • Typical Practices
    • CSN supports VPC custom route tables for secure traffic access
    • Multi-IDC Disaster Recovery via Cloud Smart Network
    • Multi-IDC Interconnection via Cloud Smart Network
    • Private Network VPC Interconnection with Edge Network
  • Document center
  • arrow
  • CSN
  • arrow
  • API Reference
  • arrow
  • Appendix
Table of contents on this page
  • Definition of related model object
  • Csn
  • Instance
  • Billing
  • Reservation
  • CsnBp
  • CsnBpLimit
  • CsnRtAssociation
  • CsnRouteTable
  • CsnRtPropagation
  • CsnRtRule
  • Tgw
  • TgwRtRule
  • TagModel

Appendix

Updated at：2025-11-11

Definition of related model object

Csn

Parameter name Types Description
csnId String ID of CSN
name String Name of CSN
description String Description of CSN
status String Status of CSN
instanceNum Integer Number of CSN network instances
csnBpNum Integer Number of CSN bandwidth packages
createTime String Creation time of CSN
tags List<TagModel> Collection of tags bound to CSN

Instance

Parameter name Types Description
attachId String Identity ID of the network instance in Cloud Smart Network
instanceType String Value range: [vpc | channel | bec_vpc], representing VPC, dedicated channel, and edge network respectively
instanceId String ID of the network instance
instanceName String Name of network instance
instanceRegion String Region to which the network instance belongs
instanceAccountId String ID of the root account to which the network instance belongs
status String Status of the network instance. Value range: [attached | attaching | detaching | attach_failed], representing attached, attaching, detaching, and attachment failed respectively

Billing

Parameter name Types Description
paymentTiming String Payment type: Prepaid and Postpaid
billingMethod String This parameter is required for post-paid billing. Options include ByTraffic (pay-as-you-go by traffic), ByBandwidth (pay-as-you-go by bandwidth), PeakBandwidth_Percent_95 (95th Percentile billing), and Enhanced_Percent_95 (Enhanced 95th percentile billing).
reservation Reservation Reserved information, not required when payment method is Postpay, but must be set when it is Prepay

Reservation

Parameter name Types Description
reservationLength Integer Duration: [1,2,3,4,5,6,7,8,9,12,24,36]
reservationTimeUnit String Time unit: Currently only monthly is supported, with the value “month”

CsnBp

Parameter name Types Description
csnBpId String ID of the bandwidth package
name String Name of the bandwidth package
bandwidth String Total bandwidth of the bandwidth packagewidth package minimum guaranteed bandwidth
usedBandwidth String Allocated bandwidth of the bandwidth package
csnId String Bound Cloud Smart Network instance
interworkType String Connection type of the bandwidth package. Value range: [center | center-edge | edge-edge], representing inter-cloud connection, cloud-edge connection, and edge-edge connection respectively
interworkRegion String Connection region of the bandwidth package. Value range: [chinesemainland | asiapacific | crossregional] representing Chinese mainland, Asia-Pacific region, and cross-region connection respectively
status String Status of the bandwidth package. Value range: [available | stopped], representing available and expired respectively
paymentTiming String Charge type of the bandwidth package. Value range: [PrePaid | PostPaid], representing prepaid and post-paid respectively
expireTime String Expiration time: Standard UTC format
createdTime String Purchase time: Standard UTC format
tags List<TagModel> Collection of tags bound to VPC

CsnBpLimit

Parameter name Types Description
csnBpId String ID of the bandwidth package
csnId String Cloud Smart Network ID
localRegion String Local region of the cross-region bandwidth; in cloud-edge connection scenarios, it represents the cloud-side region
peerRegion String Peer region of the cross-region bandwidth; in cloud-edge connection scenarios, it represents the edge region
bandwidth Integer Bandwidth value of the cross-region bandwidth

CsnRtAssociation

Parameter name Types Description
attachId String Identity ID of the network instance in Cloud Smart Network
description String Description of the association relationship
instanceId String ID of the network instance
instanceName String Name of network instance
instanceRegion String Region to which the network instance belongs
instanceType String Type of the network instance. Value range: [vpc | channel | bec_vpc]
status String Status of the association relationship

CsnRouteTable

Parameter name Types Description
csnRtId String Route table ID
name String Route table name
description String Route table description
type String Route table type. Value range: [default | custom], representing default route table and custom route table respectively

CsnRtPropagation

Parameter name Types Description
attachId String Identity ID of the network instance in Cloud Smart Network
description String Description of the learning relationship
instanceId String ID of the network instance
instanceName String Name of network instance
instanceRegion String Region to which the network instance belongs
instanceType String Type of the network instance. Value range: [vpc | channel | bec_vpc]
status String Status of the learning relationship

CsnRtRule

Parameter name Types Description
ruleId String ID of the routing entry
routeType String Type of the route entry
csnId String Cloud Smart Network ID
csnRtId String Route table ID
description String Description of the route entry
fromAttachId String Identity ID of the source network instance of the route entry in Cloud Smart Network
status String Status of the route entry. Value range: [active | conflicted], representing active and conflicted respectively
sourceAddress String Source address
destAddress String Destination address
nextHopId String ID of the next-hop network instance
nextHopName String Name of the next-hop network instance
nextHopRegion String Region information of the next-hop network instance
nextHopType String Type of the next-hop network instance
asPath String as-path
community String community
blackHole Boolean Whether it is a blackhole route

Tgw

Parameter name Types Description
tgwId String ID of the TGW
csnId String Cloud Smart Network ID
name String Name of TGW
region String Region of TGW
description String Description information of the TGW

TgwRtRule

Parameter name Types Description
ruleId String ID of the routing entry
routeType String Type of the route entry
csnId String Cloud Smart Network ID
csnRtId String Route table ID
fromAttachId String Identity ID of the source network instance of the route entry in Cloud Smart Network
status String Status of the route entry
destAddress String Destination address
nextHopId String ID of the next-hop network instance
nextHopName String Name of the next-hop network instance
nextHopRegion String Region information of the next-hop network instance
nextHopType String Type of the next-hop network instance
asPath String as-path
community String community
blackHole Boolean Whether it is a blackhole route

TagModel

Parameter name Types Description
tagKey String The key of the tag, which main contain uppercase and lowercase letters, numbers, Chinese characters, and special characters-_ /., with a length of 1-65.
tagValue String The value of the tag, which main contain uppercase and lowercase letters, numbers, Chinese characters, and special characters-_ /., with a length of 0-65.

Previous
API function release records
Next
Bandwidth Package Related