All Products
Search

This Product

    Tair (Redis® OSS-Compatible):DescribeIntranetAttribute

    Document Center

    Tair (Redis® OSS-Compatible):DescribeIntranetAttribute

    Last Updated:Oct 23, 2026

    Queries the current bandwidth of an ApsaraDB for Tair (Redis® OSS-Compatible) database instance.

    Operation description

    You can call the EnableAdditionalBandwidth operation to purchase bandwidth for an instance.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    kvstore:DescribeIntranetAttribute

    get

    *DBInstance

    acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    The instance ID.

    r-bp1zxszhcgatnx****
    ResourceGroupId

    string

    No

    The resource group ID.

    rg-acfmyiu4ekp****

    Response elements

    Element

    Type

    Description

    Example

    object

    AutoRenewal

    boolean

    Specifies whether auto-renewal is enabled for the purchased bandwidth. Valid values:

    • true: Enabled.

    • false: Disabled.

    Note

    This parameter is not returned if no bandwidth is purchased.

    true
    RequestId

    string

    The request ID.

    25D42CC3-FBA1-4AEC-BCE2-B8DD3137****
    ExpireTime

    string

    The expiration time of the temporary bandwidth. The time follows the yyyy-MM-ddTHH:mm:ssZ format.

    Note

    If no temporary bandwidth adjustment has been performed on the instance or the temporary bandwidth has expired, this parameter returns 0.

    0
    IntranetBandwidth

    integer

    The current internal network bandwidth of the instance. This parameter indicates the total bandwidth of all shards in the instance. Unit: MB/s.

    102
    HasPrePaidBandWidthOrderRunning

    boolean

    Specifies whether the instance has an unexpired bandwidth plan. Valid values:

    • true: The instance has an unexpired bandwidth plan.

    • false: The instance does not have an unexpired bandwidth plan.

    Note

    This parameter is not returned if no extra bandwidth is purchased for the instance.

    true
    BandwidthExpireTime

    string

    The expiration time of the purchased bandwidth. The time follows the yyyy-MM-ddTHH:mm:ssZ format.

    Note

    This parameter is not returned if no extra bandwidth is purchased for the instance.

    2021-03-06T16:00:00Z
    BandwidthPrePaid

    string

    The billing method of the bandwidth plan. Valid values:

    • 0: Pay-as-you-go.

    • 1: Subscription.

    0
    IntranetBandWidthBurst

    integer

    The burst quota for the internal network bandwidth.

    0

    Examples

    Success response

    JSON format

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

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.