DescribeInstanceInternetBandwidthConfigs

Last Updated At: 2026-08-02 00:05:20

1. Interface Description

Interface request domain name: cvm.api3.convergecloud.com.

This API (DescribeInstanceInternetBandwidthConfigs) is used to query instance bandwidth configurations.

Only querying bandwidth configurations billed by the BANDWIDTH_PREPAID billing mode is supported.
The API returns all bandwidth configuration information (including historical bandwidth configurations) of the instance.

Default interface request rate limit: 10 times per second.

Interface update time: 2018-04-04 09:23:06.

The interface only verifies the signature but does not authenticate.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name	Required	Allow NULL	Type	Description
Action	Yes	No	String	Public parameter, The value of this interface: DescribeInstanceInternetBandwidthConfigs
Version	Yes	No	String	Public parameter, The value of this interface: 2017-03-12
Region	No	No	String	Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface
InstanceId	Yes	No	String	Instance ID to be operated. Can be obtained through the `InstanceId` in the returned value from the API DescribeInstances. Example: ins-6lafsaz0

3. Output Parameters

Parameter name	Type	Description
InternetBandwidthConfigSet	Array of InternetBandwidthConfig	List of bandwidth configuration information. Example:View
RequestId	String	Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

4. Error Code

The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

Error Code	Description
InvalidInstanceId.NotFound	No corresponding instance was found.
InvalidInstance.NotSupported	Unsupported instance.
InternalServerError	Internal operation error.
InvalidInstanceId.Malformed	Invalid Instance ID. The format of the specified instance ID is incorrect, for example, an instance ID length error `ins-1122`.
MissingParameter	Parameters are missing. The request did not include mandatory parameters.