All Products
Search
Document Center

Elastic Desktop Service:DescribeNetworkPackages

Last Updated:Jan 18, 2023

Queries the details of one or more Internet access packages.

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.

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 IDs of the Internet access packages. You can specify 1 to 100 IDs of Internet access packages.

string No

The ID of the Internet access package.

np-amtp8e8q1o9e4****
InternetChargeType string No

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

  • PayByTraffic: pay-by-traffic
  • PayByBandwidth: pay-by-bandwidth
PayByBandwidth

Response parameters

Parameter Type Description Example
object

The object that is returned.

NextToken string

The token that is used for the next query. If this parameter is left empty, all results are returned.

caeba0bbb2be03f84eb48b699f0a4883
RequestId string

The ID of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
NetworkPackages array

Details of the Internet access packages.

object

Details of the Internet access package.

NetworkPackageId string

The ID of the Internet access package.

np-amtp8e8q1o9e4****
Bandwidth integer

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

10
ExpiredTime string

The time when the Internet access package expires.

  • If the Internet access package uses the pay-by-bandwidth billing method, the actual expiration time is returned.
  • If the Internet access package uses the pay-by-data-transfer billing method, 2099-12-31T15:59:59Z is returned.
2099-12-31T15:59:59Z
CreateTime string

The time when the Internet access package was created.

2021-05-10T02:35:26Z
OfficeSiteId string

The ID of the workspace.

cn-hangzhou+dir-363353****
PayType string
InternetChargeType string

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

  • PayByTraffic: pay-by-traffic
  • PayByBandwidth: pay-by-bandwidth
PayByTraffic
ReservationInternetChargeType string
ReservationBandwidth integer
ReservationActiveTime string
NetworkPackageStatus string

The status of the Internet access package. Valid values:

  • Creating: The Internet access package is being created.
  • InUse: The Internet access package is in use.
  • Releasing: The Internet access package is being released.
  • Released: The Internet access package is released.
InUse
OfficeSiteName string

The name of the workspace.

test
OfficeSiteVpcType string

The virtual private cloud (VPC) type of the workspace. Valid values:

  • basic: shared VPC
  • standard: exclusive VPC
  • customized: user VPC
basic
EipAddresses array

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

Example

Normal return example

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": "",
      "InternetChargeType": "PayByTraffic",
      "ReservationInternetChargeType": "",
      "ReservationBandwidth": 0,
      "ReservationActiveTime": "",
      "NetworkPackageStatus": "InUse",
      "OfficeSiteName": "test",
      "OfficeSiteVpcType": "basic",
      "EipAddresses": [
        "120.2.XX.XX"
      ]
    }
  ]
}

Error codes

For a list of error codes, visit the API error center.

Change history

Change time Summary of changes Operate
2021-08-19 The input parameters of the API operation has changed
Change item Change content
Input Parameters The input parameters of the API operation has changed
    Added Input Parameters: InternetChargeType