vpc · 2017-03-12

DescribeBandwidthPackages

POST

Query bandwidth package information, including the unique ID of the bandwidth package, the type, the billing mode, the name, and the resource information.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /vpc/DescribeBandwidthPackages path used in the OpenAPI document is a documentation convenience so each action is addressable; it is not a route on the server.

curl

curl -sS https://vpc.api3.convergecloud.com/ \
  -H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/vpc/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'Host: vpc.api3.convergecloud.com' \
  -H 'X-TC-Action: DescribeBandwidthPackages' \
  -H 'X-TC-Version: 2017-03-12' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{}'

Request parameters

Field	Type	Required	Description
BandwidthPackageIds	string[]	—	The unique ID list of bandwidth packages.
Filters	Filter[]	—	Each request can have up to 10 `Filters`. parameters do not support specifying `BandwidthPackageIds` and `Filters` at the same time. detailed filter criteria are as follows:.
Offset	integer	—	Offset. This value defaults to 0. For more information on Offset, see the relevant section in the API Introduction.
Limit	integer	—	Number of bandwidth packages returned. This value defaults to 20. The maximum is 100. For more information on Limit, see the relevant section in the API Introduction.

Response

Fields are returned inside the Response envelope. Converge Cloud answers HTTP 200 for errors as well as successes, so read Response.Error rather than the status code — and test for the presence of that object, because Code is occasionally the empty string.

Field	Type	Description
TotalCount	integer	The number of eligible bandwidth packages.
BandwidthPackageSet	BandwidthPackage[]	Detail information of the bandwidth package.
RequestId	string	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

Success

{
  "Response": {
    "TotalCount": …,
    "BandwidthPackageSet": …,
    "RequestId": "…"
  }
}

Error

{
  "Response": {
    "Error": { "Code": "…", "Message": "…" },
    "RequestId": "…"
  }
}

Try it

CredentialThe key never leaves this tab — it signs the request here. The signed request goes to /api-relay/vpc.

SecretIdSecretKey

Request bodyvalid JSONPOST vpc.api3.convergecloud.com · DescribeBandwidthPackages

{}

Read-only. Creates nothing.

Recorded example response

{
  "TotalCount": 0,
  "BandwidthPackageSet": []
}