Use ModifyInstanceNetExpireTime to extend the classic network endpoint expiration time - Tair (Redis® OSS-Compatible) - Alibaba Cloud - Tair (Redis® OSS-Compatible)

Operation description

You can also perform this operation in the Tair (Redis OSS-compatible) console. For more information, see Change the expiration time for the classic network endpoint.

Note

For more information about how to switch the network type of a Tair (Redis OSS-compatible) instance from classic network to VPC, see SwitchNetwork.

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:ModifyInstanceNetExpireTime

update

*DBInstance

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

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance.	r-bp1zxszhcgatnx****
ConnectionString	string	Yes	The endpoint of the classic network.	r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com
ClassicExpiredDays	integer	Yes	The extension period for retaining the classic network endpoint. Unit: days. Valid values: 14, 30, 60, and 120.	14

Response elements

Element	Type	Description	Example
	object
InstanceId	string	The ID of the instance.	r-bp1zxszhcgatnx****
RequestId	string	The ID of the request.	9C4AF387-1EA3-4C84-8013-3F6B973EDDF5
NetInfoItems	object
NetInfoItem	array<object>	The retention details of the classic network endpoint.
	object	The classic network details of the instance.
Port	string	The port used to connect to the instance.	6379
DBInstanceNetType	string	The network type of the instance. The returned value is Classic.	Classic
ConnectionString	string	The endpoint of the classic network.	r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com
ExpiredTime	string	The expiration time of the classic network endpoint.	2019-08-01T09:29:18Z
IPAddress	string	The IP address of the instance in the classic network.	100.118.142.***

Examples

Success response

JSON format

{
  "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 response

JSON format

{
	"InstanceId": "r-xxxxxxxxxxxxxxx",
	"RequestId": "9C4AF387-1EA3-4C84-8013-3F6B973EDDF5",
	"NetInfoItems": {
		"NetInfoItem": [{
				"ConnectionString": "r-xxxxxxxxxxxxxxx.redis.rds.aliyuncs.com",
				"Port": "6379",
				"DBInstanceNetType": "Classic",
				"IPAddress": "xxx.xxx.xxx.xxx",
				"ExpiredTime": "2018-11-18T08:04:46Z"
			}
		]
	}
}

Error codes

HTTP status code	Error code	Error message	Description
400	ClassicExpiredDaysError	The ClassicExpiredDays can not set to 0.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.