CreateNetworkPackage - Elastic Desktop Service - Alibaba Cloud Documentation Center

Creates a premium bandwidth plan for an office network.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
Bandwidth	integer	Yes	The bandwidth provided by the premium bandwidth plan. Unit: Mbit/s. Valid values if the premium bandwidth plan is a subscription plan: 2 to 1000. Valid values if the premium bandwidth plan is a pay-as-you-go plan that charges by data transfer (PayByTraffic): 2 to 200. Valid values if the premium bandwidth plan is a pay-as-you-go plan that charges by fixed bandwidth (PayByBandwidth): 2 to 1000.	10
OfficeSiteId	string	Yes	The office network ID.	cn-hangzhou+dir-363353****
PayType	string	No	The billing method of the premium bandwidth plan. Valid values: PostPaid: pay-as-you-go PrePaid: subscription	PrePaid
InternetChargeType	string	No	The charge type of the premium bandwidth plan. Valid value when the `PayType` parameter is set to `PrePaid`: PayByBandwidth: charges by fixed bandwidth. Valid values when the `PayType` parameter is set to `PostPaid`: PayByTraffic: charges by data transfer. PayByBandwidth: charges by fixed bandwidth.	PayByTraffic
Period	integer	No	The subscription duration of the premium bandwidth plan. This parameter takes effect and is required only when the `PayType` parameter is set to `PrePaid`. The valid values of this parameter vary based on the `PeriodUnit` value. Valid value when the `PeriodUnit` parameter is set to `Week`: 1 Valid values when the `PeriodUnit` parameter is set to `Month`: 1, 2, 3, and 6 Valid values when the `PeriodUnit` parameter is set to `Year`: 1, 2, and 3 Default value: 1.	1
PeriodUnit	string	No	The unit of the subscription duration of the premium bandwidth plan. This parameter takes effect and is required only when the `PayType` parameter is set to `PrePaid`. Valid values: Month Year Week	Month
AutoPay	boolean	No	Specifies whether to enable the automatic payment feature. Valid values: true (default): enables the auto-payment feature. Make sure that your account has sufficient balance. Otherwise, no order is generated. false: disables the auto-payment feature. In this case, an order is generated but you need to make the payment manually. To make the payment, log on to the Elastic Desktop Service console, go to the Orders page, and find the order based on the order ID.	false
AutoRenew	boolean	No	Specifies whether to enable auto-renewal for the premium bandwidth plan. Valid values: true false	false
PromotionId	string	No	The ID of the sales promotion.	23141

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
NetworkPackageId	string	The ID of the premium bandwidth plan.	np-amtp8e8q1o9e4****
RequestId	string	The ID of the request.	269BDB16-2CD8-4865-84BD-11C40BC21DB0
OrderId	string	The ID of the bill.	234526262716724

Examples

Sample success responses

JSONformat

{
  "NetworkPackageId": "np-amtp8e8q1o9e4****",
  "RequestId": "269BDB16-2CD8-4865-84BD-11C40BC21DB0",
  "OrderId": "234526262716724"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2021-08-19	The request parameters of the API has changed	View Change Details