All Products
Search
Document Center

ApsaraDB for Redis:ModifyInstanceNetExpireTime

Last Updated:May 28, 2024

Extends the retention period of the classic network endpoint of an ApsaraDB for Redis instance. You can call this operation after you change the network type of the ApsaraDB for Redis instance from classic network to Virtual Private Cloud (VPC) with the classic network endpoint retained.

Operation description

You can also perform this operation in the ApsaraDB for Redis console. For more information, see Change the expiration time for the endpoint of the classic network.

Note For more information about how to switch the network type of an ApsaraDB for Redis instance from classic network to VPC, see SwitchNetwork .

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

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the instance.

r-bp1zxszhcgatnx****
ConnectionStringstringYes

The endpoint of the classic network.

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

The extension period to retain the classic network endpoint of the instance. Unit: days. Valid values: 14, 30, 60, and 120.

14

Response parameters

ParameterTypeDescriptionExample
object
InstanceIdstring

The ID of the instance.

r-bp1zxszhcgatnx****
RequestIdstring

The ID of the request.

9C4AF387-1EA3-4C84-8013-3F6B973EDDF5
NetInfoItemsobject []

Details of the extension period for which the classic network endpoint of the instance is retained.

Portstring

The port number that is used to connect to the instance.

6379
DBInstanceNetTypestring

The network type of the instance. The returned value is Classic.

Classic
ConnectionStringstring

The endpoint of the classic network.

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

The expiration time of the classic network endpoint.

2019-08-01T09:29:18Z
IPAddressstring

The IP address of the instance in the classic network.

100.118.142.***

Examples

Sample success responses

JSONformat

{
  "InstanceId": "r-bp1zxszhcgatnx****",
  "RequestId": "9C4AF387-1EA3-4C84-8013-3F6B973EDDF5",
  "NetInfoItems": {
    "NetInfoItem": [
      {
        "Port": "6379",
        "DBInstanceNetType": "Classic",
        "ConnectionString": "r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com",
        "ExpiredTime": "2019-08-01T09:29:18Z",
        "IPAddress": "100.118.142.***"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError message
400ClassicExpiredDaysErrorThe ClassicExpiredDays can not set to 0.

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