DescribeNetworkPackages - WUYING Workspace - Alibaba Cloud Documentation Center

Queries the details of one or more premium bandwidth plans.

Debugging

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

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
MaxResults	integer	No	The number of entries to return on each page. Maximum value: 100 Default value: 10	10
NextToken	string	No	The token that determines the start point of the next query.	caeba0bbb2be03f84eb48b699f0a4883
NetworkPackageId	array	No	The ID of the premium bandwidth plan. You can specify 1 to 100 IDs.
	string	No	The ID of the premium bandwidth plan.	np-amtp8e8q1o9e4****
InternetChargeType	string	No	The charge type of the pay-as-you-go premium bandwidth plan. Valid values: PayByTraffic: charges by data transfer. PayByBandwidth: charges by fixed bandwidth.	PayByBandwidth

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
NextToken	string	The token that is used to start the next query. If the value of this parameter is empty, all results are returned.	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	The ID of the request.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
NetworkPackages	object []	The premium bandwidth plans.
NetworkPackageId	string	The ID of the premium bandwidth plan.	np-amtp8e8q1o9e4****
Bandwidth	integer	The bandwidth provided by the premium bandwidth plan. Unit: Mbit/s.	10
ExpiredTime	string	The time when the premium bandwidth plan expires. If the plan is a subscription one, the time when the plan expires is returned. If the plan is a pay-as-you-go one, `2099-12-31T15:59:59Z` is returned.	2099-12-31T15:59:59Z
CreateTime	string	The time when the premium bandwidth plan was created.	2021-05-10T02:35:26Z
OfficeSiteId	string	The office network ID.	cn-hangzhou+dir-363353****
PayType	string	The billing method of the premium bandwidth plan. Valid values: PostPaid: pay-as-you-go PrePaid: subscription	PostPaid
InternetChargeType	string	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
ReservationInternetChargeType	string	The billing method of the reserved network bandwidth. Valid values: PayByTraffic: charges by data transfer. PayByBandwidth: charges by fixed bandwidth.	PayByBandwidth
ReservationBandwidth	integer	The peak bandwidth that is reserved for the premium bandwidth plan. Unit: Mbit/s.	20
ReservationActiveTime	string	The time when the reserved network bandwidth took effect.	2021-07-10T00:00:00Z
NetworkPackageStatus	string	The status of the premium bandwidth plan. Valid values: Creating Released InUse Releasing	InUse
OfficeSiteName	string	The office network name.	test
OfficeSiteVpcType	string	The type of the office network. Valid values: standard: advanced office network customized: custom office network basic: basic office network	basic
EipAddresses	array	The public egress IP address of the premium bandwidth plan.
	string	The public egress IP address of the premium bandwidth plan.	120.2.XX.XX
BusinessStatus	string	The business status. Valid values: Expired Normal	Normal

Examples

Sample success responses

JSONformat

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "NetworkPackages": [
    {
      "NetworkPackageId": "np-amtp8e8q1o9e4****",
      "Bandwidth": 10,
      "ExpiredTime": "2099-12-31T15:59:59Z",
      "CreateTime": "2021-05-10T02:35:26Z",
      "OfficeSiteId": "cn-hangzhou+dir-363353****",
      "PayType": "PostPaid",
      "InternetChargeType": "PayByTraffic",
      "ReservationInternetChargeType": "PayByBandwidth",
      "ReservationBandwidth": 20,
      "ReservationActiveTime": "2021-07-10T00:00:00Z",
      "NetworkPackageStatus": "InUse",
      "OfficeSiteName": "test",
      "OfficeSiteVpcType": "basic",
      "EipAddresses": [
        "120.2.XX.XX"
      ],
      "BusinessStatus": "Normal"
    }
  ]
}

Error codes

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

Change history

Change time

Summary of changes

Operation

2023-10-26

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2021-08-19

The request parameters of the API has changed

see changesets

Change item	Change content
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: InternetChargeType