All Products
Search

This Product

    :CreateCloudPhoneNode

    Document Center

    :CreateCloudPhoneNode

    Last Updated:Dec 18, 2025

    Creates a Cloud Phone matrix. In Cloud Phone, a matrix is a logical resource management unit that represents a physical server instance. You can partition the physical server into multiple independent Cloud Phone instances. These instances share the computing, storage, and network resources of the matrix. Creating a matrix provisions a physical server. You can then create Cloud Phone instances on the server. The configuration determines the number of instances that you can create.

    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 specification of the Cloud Phone matrix.

    Valid values:

    • cpm.gn6.gx1 :

      cpm.gn6.gx1

    cpm.gx7.10xlarge

    InstanceType

    string

    No

    The instance type.

    Note

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

    Valid values:

    • ac.max :

      The default number of instances for this type is 25. Set the PhoneCount parameter to adjust the number of instances. The valid range is 4 to 40.

    • ac.plus :

      The default number of instances for this type is 40. Set the PhoneCount parameter to adjust the number of instances. The valid range is 4 to 40.

    ac.max

    ChargeType

    string

    No

    The billing method. Currently, only the subscription billing method 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 the PeriodUnit parameter.

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

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

    1

    AutoPay

    boolean

    No

    Specifies whether to enable automatic payment.

    Valid values:

    • flase :

      Manually complete the payment in the Alibaba Cloud Expenses and Costs console. (default)

    • true :

      Automatic payment.

    true

    AutoRenew

    boolean

    No

    Specifies whether to enable auto-renewal.

    Valid values:

    • true :

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

    • false :

      Auto-renewal is disabled. You must manually renew the instance when it 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 tag 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 local phone storage. Unit: GiB.

    10

    ServerShareDataVolume

    integer

    No

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

    Note

    The minimum size of the shared phone 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 in pixels.

    1280

    ResolutionWidth

    integer

    No

    The width of the resolution in 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.

    null

    LockResolution

    string

    No

    Specifies whether to lock the resolution.

    Valid values:

    • off :

      Does not lock the resolution.

    • on :

      Locks the resolution.

    off

    StreamMode

    integer

    No

    The streaming mode for instances in the Cloud Phone matrix. If you do not specify this parameter, the preemption mode is used by default.

    Valid values:

    • 1 :

      Preemption mode

    • 2 :

      Collaboration mode

    1

    NetworkType

    string

    No

    The network type of the instance.

    Valid values:

    • network_pro_ecd :

      Advanced office network for Elastic Desktop Service

    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 limited by this value.

    200

    InternetChargeType

    string

    No

    The billing method 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 :

      One elastic IP address (EIP) is assigned to every 128 Cloud Phone instances.

    128

    Isp

    string

    No

    The line type.

    Valid values:

    • ChinaUnicom :

      China Unicom

    • ChinaTelecom :

      China Telecom

    • ChinaMobile :

      China Mobile

    • BGP :

      BGP (Multi-ISP)

    ChinaTelecom

    PayType

    string

    No

    The billing method.

    Valid values:

    • PostPaid :

      Pay-as-you-go

    • PrePaid :

      Subscription

    PostPaid

    VisibleType

    string

    No

    The visibility scope.

    CPS

    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 maximum upstream bandwidth. Unit: Mbit/s.

    50

    DownBandwidthLimit

    integer

    No

    The maximum downstream bandwidth. Unit: Mbit/s.

    50

    UseTemplate

    string

    No

    Specifies whether to use a template to create the instance. Set the value to Random to use a random template from the template list. To use a specific template, enter the template ID.

    Random

    PromotionId

    string

    No

    SwapSize

    integer

    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 information about the Cloud Phone matrices.

    object

    The information about the Cloud Phone matrix.

    NodeId

    string

    The ID of the Cloud Phone matrix.

    cpn-e5kxgjyt8s1mb****

    InstanceIds

    array

    A list of Cloud Phone instance IDs.

    string

    The ID of the Cloud Phone instance.

    cpn-e5kxgjyt8s1mb****

    NetworkPackageOrderModel

    object

    The order information of the bandwidth plan.

    BandwidthPackageOrderId

    string

    The order ID of the bandwidth plan.

    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.