All Products
Search
Document Center

WUYING Workspace:DescribeNetworkPackages

Last Updated:Mar 26, 2024

Queries the details of one or more Internet access packages.

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 ID of the region.

cn-hangzhou
MaxResultsintegerNo

The number of entries to return on each page.

  • Maximum value: 100
  • Default value: 10
10
NextTokenstringNo

The token that determines the start point of the next query.

caeba0bbb2be03f84eb48b699f0a4883
NetworkPackageIdarrayNo

The IDs of the Internet access packages. You can specify 1 to 100 IDs of Internet access packages.

stringNo

The ID of the Internet access package.

np-amtp8e8q1o9e4****
InternetChargeTypestringNo

The billing method of the Internet access package. Valid values:

  • PayByTraffic: pay-by-data-transfer
  • PayByBandwidth: pay-by-bandwidth
PayByBandwidth

Response parameters

ParameterTypeDescriptionExample
object

The object that is returned.

NextTokenstring

The token that is used to start the next query. If the value of this parameter is empty, all results are returned.

caeba0bbb2be03f84eb48b699f0a4883
RequestIdstring

The ID of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
NetworkPackagesobject []

Details of the Internet access packages.

NetworkPackageIdstring

The ID of the Internet access package.

np-amtp8e8q1o9e4****
Bandwidthinteger

The maximum public bandwidth of the Internet access package. Unit: Mbit/s.

10
ExpiredTimestring

The time when the Internet access package expires.

  • If the Internet access package is metered on a pay-by-bandwidth basis, the actual expiration time is returned.
  • If the Internet access package is metered on a pay-by-data-transfer basis, 2099-12-31T15:59:59Z is returned.
2099-12-31T15:59:59Z
CreateTimestring

The time when the Internet access package was created.

2021-05-10T02:35:26Z
OfficeSiteIdstring

The ID of the workspace.

cn-hangzhou+dir-363353****
PayTypestring

The billing method for the network.

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

The billing method of the network bandwidth.

  • PayByTraffic: pay-by-data-transfer
  • PayByBandwidth: pay-by-bandwidth
PayByTraffic
ReservationInternetChargeTypestring

The billing method of the reserved network bandwidth.

  • PayByTraffic: pay-by-data-transfer
  • PayByBandwidth: pay-by-bandwidth
PayByBandwidth
ReservationBandwidthinteger

The peak bandwidth of the reserved network bandwidth. Unit: Mbit/s.

20
ReservationActiveTimestring

The time when the reserved network bandwidth takes effect.

2021-07-10T00:00:00Z
NetworkPackageStatusstring

The state of the Internet access package. Valid values:

  • Creating
  • InUse
  • Releasing
  • Released
InUse
OfficeSiteNamestring

The name of the workspace.

test
OfficeSiteVpcTypestring

The type of the workspace. Valid values:

  • basic
  • standard
  • customized
basic
EipAddressesarray

The elastic IP addresses (EIPs) of the Internet access package for outbound traffic.

string

The EIP of the Internet access package for outbound traffic.

120.2.XX.XX

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"
      ]
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-10-26The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2021-08-19The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: InternetChargeType