tencent cloud

Multiple Network Acceleration

    DokumentasiMultiple Network Acceleration

    Data Types

    Unduh
    Mode fokus
    Ukuran font
    Terakhir diperbarui: 2026-05-21 10:26:40

    ActivateHardware

    Activate device

    Used by actions: ActivateHardware.

    Name Type Required Description
    Vendor String Yes Vendor name
    SN String Yes Device SN serial number
    DeviceName String Yes Device name.
    Description String No Remarks
    DataKey String No device key
    AccessScope Integer No Access environment. 0: public cloud gateway; 1: private gateway; 2: public cloud gateway and private gateway. By default if left blank, public cloud gateway is selected. Specific meaning: Public cloud gateway: device can only integrate with public cloud gateway (nearby access). Private gateway: device can only integrate with private gateway that has been launched (nearby access or fixed ip). Public cloud gateway and private gateway: device can also integrate with public cloud gateway and private gateway that has been launched (nearby access or fixed ip).
    LicensePayMode Integer No When the payer is the tenant, the tenant license payment method is available.
    Monthly authorization
    1: Permanent license
    If not passed, it defaults to monthly authorization.
    This parameter is invalid when the manufacturer is the payer.
    GroupId String No device group ID
    GroupName String No Device group name. Reserved parameter. GroupId must be imported when grouping is required.
    FlowTrunc Integer No No traffic processing method for the device. 0: pay-as-you-go, 1: truncate and accelerate
    DeviceId String No Device ID after activation

    ActiveDeviceList

    Activated device statistics

    Used by actions: GetActiveDeviceCount.

    Name Type Description
    Count Integer Quantity.
    Time String Time

    DelApplicationList

    Application ID list

    Used by actions: DeleteApplication.

    Name Type Required Description
    MpApplicationId String Yes Application ID.

    DestIpInfo

    Target IP info

    Used by actions: GetDestIPByName.

    Name Type Description
    Time String Time: s
    GatewayIp String Gateway IP
    Note: This field may return null, indicating that no valid values can be obtained.
    GatewaySite String gateway address
    Note: This field may return null, indicating that no valid values can be obtained.
    IpCount Integer Number of target IPs
    Note: This field may return null, indicating that no valid values can be obtained.
    IpList Array of String Target IP list
    Note: This field may return null, indicating that no valid values can be obtained.

    DeviceBaseInfo

    basic device information

    Used by actions: GetDevice, GetDevices, GetGroupDetail.

    Name Type Description
    DeviceId String

    Unique ID of the device
    DeviceName String

    Device name
    CreateTime String

    The time when the device is created, in ms
    LastTime String

    Last online time of the device, in ms
    Remark String

    Remark of the device
    AccessScope Integer

    Access environment. 0: public cloud gateway; 1: private gateway; 2: public cloud gateway and private gateway. Defaults to public cloud gateway. Specific meaning: Public cloud gateway: The device can only access the public cloud gateway (nearby access). Private gateway: The device can only access the already launched private gateway (nearby access or fixed ip access). Public cloud gateway and private gateway: The device can also access both the public cloud gateway and the already launched private gateway (nearby access or fixed ip access).
    LicensePayMode Integer

    license authorization validity period 0: monthly authorization 1: permanent license
    Payer Integer

    Payment party 0: Manufacturer pays 1: Customer pays
    GroupId String

    device group ID
    GroupName String

    Device group name
    FlowTrunc Integer

    Device data transfer plan processing method, 0: pay-as-you-go, 1: truncate acceleration
    Sn String

    Device sn
    Vendor String

    Manufacturer
    AllowedRegions Array of String

    Access region list.

    DeviceDetails

    device details

    Used by actions: GetDevice.

    Name Type Description
    DeviceBaseInfo DeviceBaseInfo Device basic info
    DeviceNetInfo Array of DeviceNetInfo Device network info
    GatewaySite String Aggregate server address
    BusinessDownRate Float Downlink Rate
    BusinessUpRate Float Business-wise uplink rate

    DeviceNetInfo

    Device network status information

    Used by actions: GetDevice.

    Name Type Description
    Type Integer Network type:
    Data
    1:Wi-Fi
    2: Wired
    DataEnable Boolean Enable or disable.
    UploadLimit String Uplink speed limit
    DownloadLimit String Downstream speed limit
    DataRx Integer receive real-time speed
    DataTx Integer Send real-time speed
    Vendor Integer Operator type:
    1: CMCC;
    2: CTCC
    3: CUCC
    State Integer Connection status:
    0: connectionless
    1: Connecting
    2: Connected
    PublicIp String Public IP address
    SignalStrength Integer Signal strength/Measurement unit: dbm
    Rat Integer Data network type:
    -1: Invalid value.
    2:2G
    3:3G
    4:4G
    5:5G
    NetInfoName String NIC Name
    DownRate Float Downstream real-time rate (floating-point type replaces the integer type of the previous version DataRx).
    UpRate Float Uplink real-time rate (floating-point type replaces the integer of the previous version TxRate)

    DevicePayModeInfo

    Device payment mode info

    Used by actions: GetDevicePayMode.

    Name Type Description
    DeviceId String device ID
    PayMode Integer Payment mode.
    Prepaid Traffic Package
    0: Pay-as-you-go by traffic
    PayModeDesc String Payment mode description.
    ResourceId String Traffic package ID. Only available when the payment mode is package type.

    FlowDetails

    Device traffic information

    Used by actions: GetMultiFlowStatistic.

    Name Type Description
    NetDetails Array of NetDetails Traffic data point
    DeviceId String device ID
    MaxValue Float Maximum value of traffic (measurement unit: bytes)
    AvgValue Float Average traffic (unit: bytes)
    TotalValue Float Total traffic (unit: bytes)

    FlowPackageInfo

    Traffic package information

    Used by actions: GetFlowPackages.

    Name Type Description
    ResourceId String Unique resource ID of the data transfer plan
    AppId Integer User AppId belonging to the data transfer plan
    PackageType String Traffic package specification type. Values are as follows:
    DEVICE_1_FLOW_20G,DEVICE_2_FLOW_50G,
    DEVICE_3_FLOW_100G,
    DEVICE_5_FLOW_500G represents traffic packages of 20G, 50G, 100G, and 500G gear selection.
    Gear selection also impacts the bandwidth cap of the data transfer plan.
    20G: Bind up to 1 device.
    50G: Bind up to 2 devices.
    100G: Bind up to 3 devices.
    500G: Bind up to 5 devices.
    Status Integer Traffic packet status. 0: Inactive, 1: Within validity period, 2: Expired.
    CreateTime Integer Purchase time, Unix timestamp format, unit: second
    ActiveTime Integer Effective time, Unix Timestamp Format, unit: second
    ExpireTime Integer Expiration time, Unix Timestamp Format, unit: second
    DeviceList Array of String Device ID list bound to the data transfer plan
    CapacitySize Integer Total traffic plan capacity (unit: MB)
    CapacityRemain Integer Remaining data transfer plan, unit: MB
    RenewFlag Boolean Auto-renewal flag. true represents auto-renewal, false represents no auto-renewal.
    ModifyStatus Integer Resource package change status: 0: No change; 1: Changing; 2: Changed or renewed
    TruncFlag Boolean Traffic truncation flag. true to enable traffic truncation, false to disable traffic truncation.
    CapacityRemainPrecise Integer Precise remaining data transfer plan, unit: MB

    GroupInfo

    Basic info of the group

    Used by actions: GetGroupDetail, GetGroupList.

    Name Type Required Description
    GroupId String No group ID
    GroupName String No Group name
    CreateTime String No The time when the group is created, in ms.
    UpdateTime String No The time when the group is updated, in ms.
    Description String No Group description
    DeviceNum Integer No Number of devices grouped in

    Hardware

    Create Hardware input parameters

    Used by actions: AddHardware.

    Name Type Required Description
    SN String Yes Hardware Serial Number
    LicenseChargingMode Integer Yes license billing mode:
    1. Tenant payment
    2: Manufacturer monthly payment
    3: Manufacturer permanent license
    Description String No Device description
    HardwareId String No Hardware ID. No need to pass as an input parameter.

    HardwareInfo

    Hardware Information

    Used by actions: GetHardwareList.

    Name Type Description
    DeviceId String device ID
    DeviceName String Device name.
    ActiveTime String Activation time
    LastOnlineTime String Last online time
    Description String Remarks
    VendorDescription String vendor remarks
    LicenseChargingMode Integer License billing mode: 1. Tenant monthly payment 2. Manufacturer monthly payment 3. Permanent license.
    Note: This parameter will be subsequently deprecated. Please use LicensePayMode and Payer for new access.
    CreateTime String Creation time.
    SN String Hardware Serial Number
    LicensePayMode Integer Authorization validity period of license
    0: Monthly authorization
    1: Permanent license
    Payer Integer Payer
    0: Customer payment
    1: Manufacturer payment
    GroupId String device group ID
    GroupName String Device group name
    FlowTrunc Integer No traffic processing method for the device. 0: pay-as-you-go, 1: truncate and accelerate

    L3ConnInfo

    Layer 3 interconnection rule information

    Used by actions: GetL3ConnList.

    Name Type Required Description
    L3ConnId String No Interconnection rule ID
    DeviceId1 String No interworking device ID
    Cidr1 String No Interconnection rule CIDR
    DeviceId2 String No interworking device ID
    Cidr2 String No Interconnection rule CIDR
    Enable Boolean No Rule Enable Status
    Description String No Interconnection rule description

    MonitorData

    Traffic monitoring metrics

    Used by actions: GetNetMonitor, GetNetMonitorByName.

    Name Type Description
    Time String Time point: s
    BusinessMetrics Float Business Metric (bps/ms/%)
    SlotNetInfo Array of SlotNetInfo Network interface status info

    NetDetails

    Network details

    Used by actions: GetFlowStatistic, GetFlowStatisticByGroup, GetFlowStatisticByName, GetFlowStatisticByRegion, GetMultiFlowStatistic.

    Name Type Description
    Current Float Traffic volume (byte)
    Time String Time point, unit: s

    OrderInfo

    Return the reported order information

    Used by actions: ReportOrder.

    Name Type Description
    Uin String Account uin of the parent account
    ProjectId String Project ID
    PackageType String Usage type
    OrderId String Order number unique identifier
    ReportMonth String Report month, current month by default
    Updated String Data update time

    RegionInfo

    This data structure displays available region information.

    Used by actions: DescribeAccessRegions.

    Name Type Required Description
    RegionId String No

    Region ID.
    RegionName String No

    Region name.
    RegionAbbr String No

    English abbreviation of the region.

    SlotNetInfo

    NIC traffic metric data

    Used by actions: GetNetMonitor, GetNetMonitorByName.

    Name Type Description
    NetInfoName String NIC Name
    PublicIP String Public IP address
    Current Float Metric data (bps/ms/%)

    UpdateNetInfo

    Update device network status information

    Used by actions: UpdateDevice.

    Name Type Required Description
    Type Integer No Network type:
    Data
    1:Wi-Fi
    DataEnable Boolean No Enable or disable.
    UploadLimit Integer No Uplink speed limit: bit
    DownloadLimit Integer No Downstream speed limit: bit.
    NetInfoName String No NIC Name

    VendorHardware

    Manufacturer Hardware Information

    Used by actions: GetVendorHardware.

    Name Type Description
    HardwareId String Hardware id
    SN String Hardware Serial Number
    CreateTime String Creation time.
    Status Integer Activation status, empty: all; 1: to be activated; 2: activated
    ActiveTime String Activation time
    Description String vendor remarks
    DeviceId String Device ID
    LicenseChargingMode Integer License billing mode: 1. Tenant monthly payment 2. Manufacturer monthly payment 3. Permanent license.
    Note: When the device is paid by the tenant and inactive (not selected for monthly or permanent payment), this parameter returns 1, indicating only that the tenant has paid. This parameter will be subsequently deprecated. For new access, please use LicensePayMode and Payer.
    LastOnlineTime String Last online time
    LicensePayMode Integer Authorization validity period
    Monthly authorization
    1: Permanent license
    -Unknown
    Payer Integer Payer
    0: Customer payment
    1: Manufacturer payment

    Bantuan dan Dukungan

    Apakah halaman ini membantu?

    masukan