CreateNetworkPackage-阿里云帮助中心

Creates a network package 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 the DescribeRegions operation to get the list of regions supported by Elastic Desktop Service.	cn-hangzhou
Bandwidth	integer	Yes	The bandwidth of the network package, in Mbps. For subscription network packages, the value range is 2 to 1,000. For pay-as-you-go network packages that are billed by traffic, the value range is 2 to 200. For pay-as-you-go network packages that are billed by bandwidth, the value range is 2 to 1,000.	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 billing method for the network package. When `PayType` is set to `PrePaid`, the only valid value is: `PayByBandwidth`: pay-by-bandwidth. When `PayType` is set to `PostPaid`, valid values are: `PayByTraffic`: pay-by-traffic. `PayByBandwidth`: pay-by-bandwidth. Valid values: PayByTraffic : pay-by-traffic PayByBandwidth : pay-by-bandwidth	PayByTraffic
Period	integer	No	The subscription duration of the network package. This parameter is required and applies only when `PayType` is set to `PrePaid`. The valid values for this parameter depend on the value of `PeriodUnit`. If `PeriodUnit` is set to `Week`, the only valid value is 1. If `PeriodUnit` is set to `Month`, valid values are 1, 2, 3, and 6. If `PeriodUnit` is set to `Year`, valid values are 1, 2, and 3. Default value: 1.	1
PeriodUnit	string	No	The unit of the subscription duration for the network package. This parameter is required and applies only when `PayType` is set to `PrePaid`. Valid values: Month : Month Year : Year Week : Week	Week
AutoPay	boolean	No	Specifies whether to enable auto-payment. Valid values: true : Enables auto-payment. Ensure your account has a sufficient balance. Otherwise, an unpaid order is created. [Default] false : Creates an order without completing the payment. You can log in to the console, go to User Center > My Orders, and pay for the order using the returned order ID.	false
AutoRenew	boolean	No	Specifies whether to enable auto-renewal. Valid values: true : Enables auto-renewal. false : Disables auto-renewal.	false
PromotionId	string	No	The promotion ID.	23141
ResellerOwnerUid	integer	No
ChannelCookie	string	No

Response elements

Element	Type	Description	Example
	object	The response object.
NetworkPackageId	string	The ID of the created network package.	np-amtp8e8q1o9e4****
RequestId	string	The ID of the request.	269BDB16-2CD8-4865-84BD-11C40BC21DB0
OrderId	string	The ID of the order.	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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.