Queries the internal bandwidth of an ApsaraDB for Redis instance. If you have adjusted the internal bandwidth, this operation also returns the expiration time of the internal bandwidth.

You can call the EnableAdditionalBandwidth operation to increase the internal bandwidth of an instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeIntranetAttribute

The operation that you want to perform. Set the value to DescribeIntranetAttribute.

InstanceId String Yes r-bp1zxszhcgatnx****

The ID of the instance.

RegionId String No cn-hangzhou

The region ID of the instance.

ResourceGroupId String No rg-acfmyiu4ekp****

The ID of the resource group to which the instance belongs.

Response parameters

Parameter Type Example Description
AutoRenewal Boolean true

Indicates whether auto-renewal is enabled for the extra internal bandwidth that you purchased. Valid values:

  • true: Auto-renewal is enabled.
  • false: Auto-renewal is disabled.
Note If no extra internal bandwidth is purchased, this parameter is not returned.
BandwidthExpireTime String 2021-03-06T16:00:00Z

The time when the extra internal bandwidth that you purchased expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

Note If no extra internal bandwidth is purchased, this parameter is not returned.
ExpireTime String 0

The time when the extra internal bandwidth that you purchased for temporary use expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

Note If no internal bandwidth for temporary use is purchased or the internal bandwidth that you purchased for temporary use has expired, the value 0 is returned for this parameter.
IntranetBandwidth Integer 102

The internal bandwidth of the instance. Unit: MB/s.

RequestId String 25D42CC3-FBA1-4AEC-BCE2-B8DD3137****

The ID of the request.

Examples

Sample requests

https://r-kvstore.aliyuncs.com/?Action=DescribeIntranetAttribute
&InstanceId=r-bp1zxszhcgatnx****
&<Common request parameters>

Sample success responses

XML format

<DescribeIntranetAttributeResponse>
      <IntranetBandwidth>102</IntranetBandwidth>
      <RequestId>25D42CC3-FBA1-4AEC-BCE2-B8DD3137****</RequestId>
      <BandwidthExpireTime>2021-03-06T16:00:00Z</BandwidthExpireTime>
      <AutoRenewal>true</AutoRenewal>
      <ExpireTime>0</ExpireTime>
</DescribeIntranetAttributeResponse>

JSON format

{
	"IntranetBandwidth": 102,
	"RequestId": "25D42CC3-FBA1-4AEC-BCE2-B8DD3137****",
	"BandwidthExpireTime": "2021-03-06T16:00:00Z",
	"AutoRenewal": true,
	"ExpireTime": "0"
}

Error codes

For a list of error codes, visit the API Error Center.