Use CreateNetworkPackage to create a premium bandwidth plan for an office network - Elastic Desktop Service - Alibaba Cloud - Elastic Desktop Service

Creates a premium bandwidth plan for an office network.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecd:CreateNetworkPackage

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call DescribeRegions to query the regions supported by Elastic Desktop Service.	cn-hangzhou
Bandwidth	integer	Yes	The bandwidth of the premium bandwidth plan. Unit: Mbit/s. If the premium bandwidth plan uses the subscription billing method, the valid values are 2 to 1000. If the premium bandwidth plan uses the pay-as-you-go billing method and the metering method is pay-by-data-transfer (PayByTraffic), the valid values are 2 to 200. If the premium bandwidth plan uses the pay-as-you-go billing method and the metering method is pay-by-bandwidth (PayByBandwidth), the valid values are 2 to 1000.	2
OfficeSiteId	string	No	The office network ID.	cn-hangzhou+dir-363353****
PayType	string	No	The billing method. Valid values: PostPaid : pay-as-you-go. PrePaid : subscription.	PrePaid
InternetChargeType	string	No	The billable methods of the premium bandwidth plan. When the parameter `PayType` is set to `PrePaid`, the valid value is: PayByBandwidth: billing by fixed bandwidth. When the parameter `PayType` is set to `PostPaid`, the valid values are: PayByTraffic: billing by data transfer. PayByBandwidth: billing by fixed bandwidth. Valid values: PayByTraffic : pay-by-data-transfer. PayByBandwidth : pay-by-bandwidth.	PayByTraffic
Period	integer	No	The subscription duration of the premium bandwidth plan. This parameter takes effect and is required only when PayType is set to PrePaid. Valid values are determined by the PeriodUnit parameter. If PeriodUnit is set to Week, the valid value is 1. If PeriodUnit is set to Month, the valid values are 1, 2, 3, and 6. If PeriodUnit is set to Year, the valid values are 1, 2, and 3. Default value: 1.	1
PeriodUnit	string	No	The unit of the subscription duration for the premium bandwidth plan. This parameter takes effect and is required only when PayType is set to PrePaid. Valid values: Month : Month Year : Year Week : Week	Week
AutoPay	boolean	No	Specifies whether to enable automatic payment. Valid values: true : Automatic payment is enabled. Make sure that your account balance is sufficient. Otherwise, abnormal orders are generated. [Default value] false : An order is generated but not paid. You can log on to the console and go to the Orders page in User Center to pay for the order based on the returned order ID.	false
AutoRenew	boolean	No	Specifies whether to enable auto-renewal. Valid values: true : Auto-renewal is enabled. false : Auto-renewal is disabled.	false
PromotionId	string	No	The promotion activity ID.	23141
ResellerOwnerUid	integer	No	The user ID of resource ownership in the reseller pattern. You do not need to specify this parameter if you are not using the reseller pattern.	1422724566551XXX
ChannelCookie	string	No	Note This field is not publicly available.	PBKB1QbqEl2tslEuU6gRrLxvCFBU2M%2FVD0Eru6Oo%2FI9LTU3XQhvq3PGMWarE%2BPJdkNvCqT3blqlRSthNy4A%2BJQ%3D%3D
Tag	array<object>	No	The tags. A maximum of 20 tags are supported.
	object	No
Key	string	No	The tag key. If you specify this parameter, the value cannot be an empty string. The tag key can be up to 128 characters in length and cannot start with `aliyun` or `acs:`. The tag key cannot contain `http://` or `https://`.	TestKey
Value	string	No	The tag value. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot start with `acs:`. The tag value cannot contain `http://` or `https://`.	TestValue

Response elements

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

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	RISK.RISK_CONTROL_REJECTION	In order to protect the security of your account, the order was suspended, please contact customer service for details.	In order to protect the security of your account, the order was suspended, please contact customer service for details.
500	INTERNAL_ERROR	Internal error.	Internal error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.