All Products
Search

This Product

    ApsaraDB for Redis:ModifyIntranetAttribute

    Document Center

    ApsaraDB for Redis:ModifyIntranetAttribute

    Last Updated:Feb 20, 2024

    Temporarily adjusts the internal bandwidth of an ApsaraDB for Redis instance that is deployed in a dedicated cluster.

    Operation description

    Note
    • This operation is applicable only to an ApsaraDB for Redis instance that is deployed in a dedicated cluster. To adjust the bandwidth of a standard ApsaraDB for Redis instance, call the EnableAdditionalBandwidth operation.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    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:ModifyIntranetAttributeWRITE
    • DBInstance
      acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    InstanceIdstringYes

    The ID of the instance.

    		r-bp1zxszhcgatnx****
    BandWidthlongNo

    The amount of bandwidth that you want to add. Unit: Mbit/s. The value must be an integer greater than or equal to 0. In most cases, the maximum bandwidth that can be added can be two times the default maximum bandwidth of the current instance type. For more information about the bandwidth specifications supported by different instance types, see Overview . The bandwidth is also subject to the following limits:

    • The bandwidth of an individual instance cannot exceed 75% of the bandwidth of the host. For more information about the host specifications and bandwidth, see Instance types of hosts.
    • The total bandwidth of all of the instances on the host cannot exceed 150% of the bandwidth of the host. You can configure resource overcommitment to handle traffic spikes. For more information, see Configure resource overcommitment to reduce costs.
    Note If you do not specify this parameter for a standard instance, the bandwidth of the instance is set to two times that of the current bandwidth.
    		10
    NodeIdstringNo

    The ID of the data node. You can call the DescribeClusterMemberInfo operation to query the node ID. Separate multiple IDs with commas (,).

    Note This parameter is available and required only when the instance uses the cluster architecture.
    		r-bp1zxszhcgatnx****-db-0

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    		97AC8948-D7E4-457E-BE03-850CF04E****

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "97AC8948-D7E4-457E-BE03-850CF04E****"
}

    Error codes

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