All Products
Search

This Product

    :DescribeIntranetAttribute

    Document Center

    :DescribeIntranetAttribute

    Last Updated:Oct 30, 2024

    Queries the internal bandwidth of an ApsaraDB for Redis instance.

    Operation description

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

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    kvstore:DescribeIntranetAttributeget
    • DBInstance
      acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    InstanceIdstringYes

    The ID of the instance.

    		r-bp1zxszhcgatnx****
    ResourceGroupIdstringNo

    The ID of the resource group.

    		rg-acfmyiu4ekp****

    Response parameters

    ParameterTypeDescriptionExample
    object
    AutoRenewalboolean

    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.
    		true
    RequestIdstring

    The ID of the request.

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

    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 extra internal bandwidth for temporary use is purchased or the extra internal bandwidth that you purchased for temporary use has expired, 0 is returned for this parameter.
    		0
    IntranetBandwidthinteger

    The current internal bandwidth of the instance. Unit: Mbit/s.

    		102
    HasPrePaidBandWidthOrderRunningboolean

    Specifies whether the instance has unexpired bandwidth plans. Valid values:

    • true: The instance has unexpired bandwidth plans.
    • false: The instance does not have unexpired bandwidth plans.
    Note If no extra internal bandwidth is purchased, this parameter is not returned.
    		true
    BandwidthExpireTimestring

    The expiration time of the purchased bandwidth. The time follows the ISO 8601 standard in the yyyy-MM-dd T HH:mm:ss Z format.

    Note If no extra internal bandwidth is purchased, this parameter is not returned.
    		2021-03-06T16:00:00Z
    BandwidthPrePaidstring

    The billing methods of unexpired bandwith plans. Valid values:

    • 0: Pay-as-you-go
    • 1: Subscription
    		0

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2023-06-06The response structure of the API has changedView Change Details
    2023-03-15The response structure of the API has changedView Change Details