All Products
Search
Document Center

Elastic Desktop Service:CreateNetworkPackage

Last Updated:Jul 18, 2024

Creates a premium bandwidth plan for an office network.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
BandwidthintegerYes

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
OfficeSiteIdstringYes

The office network ID.

cn-hangzhou+dir-363353****
PayTypestringNo

The billing method of the premium bandwidth plan.

Valid values:

  • PostPaid: pay-as-you-go
  • PrePaid: subscription
PrePaid
InternetChargeTypestringNo

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
PeriodintegerNo

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
PeriodUnitstringNo

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
AutoPaybooleanNo

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
AutoRenewbooleanNo

Specifies whether to enable auto-renewal for the premium bandwidth plan.

Valid values:

  • true

  • false

false
PromotionIdstringNo

The ID of the sales promotion.

23141

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

NetworkPackageIdstring

The ID of the premium bandwidth plan.

np-amtp8e8q1o9e4****
RequestIdstring

The ID of the request.

269BDB16-2CD8-4865-84BD-11C40BC21DB0
OrderIdstring

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 timeSummary of changesOperation
2021-08-19The request parameters of the API has changedView Change Details