All Products
Search

This Product

    :CreateCloudPhoneNode

    Document Center

    :CreateCloudPhoneNode

    Last Updated:Jul 13, 2026

    Creates a cloud phone matrix. In the Wuying Cloud Phone system, a matrix (Cloud Phone Server) is a logical resource management unit that represents a physical server instance. The physical server can be divided into multiple independently running cloud phone instances that share the underlying compute, storage, and network resources of the matrix. Creating a matrix is equivalent to obtaining a physical server on which you can create cloud phone instances. The number of cloud phone instances varies based on the configuration.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request syntax

    GET  HTTP/1.1

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    BizRegionId

    string

    Yes

    The region ID.

    Valid values:

    • cn-shanghai :

      China (Shanghai)

    • ap-southeast-1 :

      Singapore.

    • eu-central-1 :

      Germany (Frankfurt)

    • cn-hangzhou :

      China (Hangzhou)

    cn-hangzhou
    NodeName

    string

    No

    The name of the cloud phone matrix.

    node_name
    ServerType

    string

    Yes

    The specifications of the cloud phone matrix.

    Valid values:

    • cpm.gn6.gx1 :

      cpm.gn6.gx1

    • cpm.gx7.10xlarge :

      cpm.gx7.10xlarge

    • cpm.gx8.16xlarge :

      cpm.gx8.16xlarge

    cpm.gx7.10xlarge
    InstanceType

    string

    No

    The instance type.

    Note

    To purchase more instance types, contact pre-sales support.

    Valid values:

    • ac.max :

      The default number of instances for this instance type is 25. You can adjust the number by setting the PhoneCount parameter. Valid values: 4 to 40.

    • ac.plus :

      The default number of instances for this instance type is 40. You can adjust the number by setting the PhoneCount parameter. Valid values: 4 to 40.

    ac.max
    ChargeType

    string

    No

    The billing type. Only subscription is supported.

    Valid values:

    • PrePaid :

      subscription.

    PrePaid
    PeriodUnit

    string

    No

    The unit of the subscription duration.

    Valid values:

    • Month :

      month [default]

    • Year :

      year.

    Month
    Period

    integer

    No

    The subscription duration. The unit is specified by PeriodUnit.

    • If PeriodUnit is set to year, the value can only be 1.

    • If PeriodUnit is set to month, valid values are 1, 2, 3, and 6.

    1
    AutoPay

    boolean

    No

    Specifies whether to enable automatic payment.

    Valid values:

    • flase :

      You must manually pay the order in the Alibaba Cloud Billing Management console. [default]

    • true :

      Automatic payment is enabled.

    true
    AutoRenew

    boolean

    No

    Specifies whether to enable auto-renewal.

    Valid values:

    • true :

      Auto-renewal is enabled. The system automatically renews the instance when the instance expires.

    • false :

      Auto-renewal is disabled. You must manually renew the instance when the instance expires. [default]

    true
    ImageId

    string

    No

    The image ID.

    imgc-075cllfeuazh0****
    Count

    string

    No

    The number of cloud phone matrices to purchase.

    1
    NetworkId

    string

    No

    The office network ID.

    cn-hangzhou+dir-5mwr9azebliva****
    VSwitchId

    string

    No

    The vSwitch ID.

    vsw-2zeekryyc1q3sm72l****
    Tag

    array<object>

    No

    The tags of the resource.

    object

    No

    The tags of the resource.

    Key

    string

    No

    The tag key.

    keyname
    Value

    string

    No

    The tag value.

    valuename
    PhoneDataVolume

    integer

    No

    The size of the independent device storage. Unit: GiB.

    10
    ServerShareDataVolume

    integer

    No

    The size of the shared device storage. Unit: GiB.

    Note

    The minimum value of the shared device storage must be greater than the number of instances in the matrix multiplied by 10 GiB.

    200
    ResolutionHeight

    integer

    No

    The height of the resolution. Unit: pixels.

    1280
    ResolutionWidth

    integer

    No

    The width of the resolution. Unit: pixels.

    720
    PhoneCount

    integer

    No

    The number of cloud phone instances to create in a single matrix.

    25
    DisplayConfig

    object

    No

    The display settings.

    Dpi

    integer

    No

    The DPI. Valid values: 72 to 600.

    240
    Fps

    integer

    No

    Note

    This parameter is not yet available for public use.

    null
    LockResolution

    string

    No

    Specifies whether to lock the resolution.

    Valid values:

    • off :

      Disabled.

    • on :

      Enabled.

    off
    StreamMode

    integer

    No

    The streaming mode for instances in the cloud phone matrix. If this parameter is not specified, the default value is preemptive mode.

    Valid values:

    • 1 :

      preemptive mode.

    • 2 :

      collaborative mode.

    1
    NetworkType

    string

    No

    The network type of the instance.

    Valid values:

    • network_pro_ecd :

      Cloud Desktop advanced office network.

    network_pro_ecd
    NetworkInfo

    object

    No

    The network mapping information of the instance.

    BandwidthPackageName

    string

    No

    The name of the bandwidth plan.

    inst-bandwidth-pkg-1
    CidrBlock

    string

    No

    The private CIDR block.

    10.10.13.0/24
    LimitedBandwidth

    integer

    No

    The maximum bandwidth of the bandwidth plan. Unit: Mbit/s. The total bandwidth of all instances that use this bandwidth plan is subject to this limit.

    200
    InternetChargeType

    string

    No

    The billable methods of the bandwidth plan. Valid values:

    - **PayByBandwidth** (default): pay-by-bandwidth.

    Valid values:

    • PayBy95 :

      pay-by-95th-percentile.

    • PayByBandwidth :

      pay-by-bandwidth.

    PayByBandwidth
    IpRatio

    integer

    No

    The ratio of IP addresses to instances.

    Valid values:

    • 128 :

      128 cloud phone instances share one EIP (public egress IP address)

    128
    Isp

    string

    No

    The line type.

    Valid values:

    • ChinaUnicom :

      China Unicom.

    • ChinaTelecom :

      China Telecom.

    • ChinaMobile :

      China Mobile.

    • BGP :

      BGP (multi-ISP) line.

    ChinaTelecom
    PayType

    string

    No

    The billing type.

    Valid values:

    • PostPaid :

      pay-as-you-go.

    • PrePaid :

      subscription.

    PostPaid
    VisibleType

    string

    No

    The visibility scope.

    CPS
    PaidCallbackUrl

    string

    No

    BandwidthPackageType

    string

    No

    The bandwidth type.

    Valid values:

    • cbwp_ecd :

      premium bandwidth plan.

    cbwp_ecd
    BandwidthPackageId

    string

    No

    The ID of the Internet Shared Bandwidth instance.

    cbwp-uf6g3hgg*******8s3lxiob3
    UpBandwidthLimit

    integer

    No

    The upstream bandwidth throttling. Unit: Mbit/s.

    50
    DownBandwidthLimit

    integer

    No

    The downstream bandwidth throttling. Unit: Mbit/s.

    50
    UseTemplate

    string

    No

    Specifies whether to use a template during creation. Set this parameter to Random to use a random template from the template list. Alternatively, specify a template ID to use that template.

    Random
    PromotionId

    string

    No

    PaidCallBackUrl

    string

    No

    SwapSize

    integer

    No

    IsSingleImgDisk

    boolean

    No

    Response elements

    Element

    Type

    Description

    Example

    object

    The request information.

    RequestId

    string

    The request ID.

    69BCBBE4-FCF2-59B8-AD9D-531EB422****
    OrderId

    string

    The order ID.

    223684716098****
    NodeInfos

    array<object>

    The cloud phone matrix information.

    object

    The cloud phone matrix information.

    NodeId

    string

    The cloud phone matrix ID.

    cpn-e5kxgjyt8s1mb****
    InstanceIds

    array

    The list of cloud phone instance IDs.

    string

    The cloud phone instance ID.

    cpn-e5kxgjyt8s1mb****
    NetworkPackageOrderModel

    object

    The bandwidth plan order information.

    BandwidthPackageOrderId

    string

    The bandwidth plan order ID.

    25954415983*****
    BandwidthPackageId

    string

    The ID of the Internet Shared Bandwidth instance.

    cbwp-uf63gsv8j0ir53*****

    Examples

    Success response

    JSON format

    {
  "RequestId": "69BCBBE4-FCF2-59B8-AD9D-531EB422****",
  "OrderId": "223684716098****",
  "NodeInfos": [
    {
      "NodeId": "cpn-e5kxgjyt8s1mb****",
      "InstanceIds": [
        "cpn-e5kxgjyt8s1mb****"
      ]
    }
  ],
  "NetworkPackageOrderModel": {
    "BandwidthPackageOrderId": "25954415983*****",
    "BandwidthPackageId": "cbwp-uf63gsv8j0ir53*****"
  }
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.