All Products
Search

This Product

    Tair (Redis® OSS-Compatible):ModifyDBInstanceConnectionString

    Document Center

    Tair (Redis® OSS-Compatible):ModifyDBInstanceConnectionString

    最終更新日:Dec 19, 2024

    Changes the endpoint or port number of a Tair (Redis OSS-compatible) instance.

    Operation description

    You can also modify the endpoint or port number of an instance in the ApsaraDB for Redis console. For more information, see Change the endpoint or port number 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:ModifyDBInstanceConnectionStringupdate
    *DBInstance
    acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DBInstanceIdstringYes

    The ID of the instance.

    		r-bp1zxszhcgatnx****
    NewConnectionStringstringNo

    The prefix of the new endpoint. Specify the endpoint in the <prefix>.redis.rds.aliyuncs.com format. The prefix must be 8 to 40 characters in length and can contain lowercase letters and digits. It must start with a lowercase letter.

    Note You must specify one of the NewConnectionString and Port parameters.
    		standardredis
    CurrentConnectionStringstringYes

    The current endpoint of the instance.

    		r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com
    PortstringNo

    The port number that is used to connect to the instance. Valid values: 1024 to 65535.

    Note You must specify one of the NewConnectionString and Port parameters.
    		6379
    IPTypestringNo

    The network type of the endpoint. Valid values:

    • Private: internal network
    • Public: Internet
    		Public

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    		1790D68A-465C-44E3-BC24-9732652961F9

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "1790D68A-465C-44E3-BC24-9732652961F9"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400NewConnectionStringNotSupportSpecified newConnectionString is not supported.-
    400InvalidIPType.FormatSpecified parameter IPType is not supported.-
    400InvalidConnectionStringOrPort.DuplicateSpecified connection string or port want to be modified is the same with current net type.The connection string or port already exists.
    400InvalidConnectionString.FormatSpecified connection string is not valid.The connection string is invalid. Use a different one.

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