ModifyNetworkConfig

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

Last updated: 2021-03-19 16:50:37

Download PDF

1. API Description

Domain name for API request: redis.tencentcloudapi.com.

This API is used to modify the network configuration of an instance.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: redis.ap-shanghai-fsi.tencentcloudapi.com

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common parameter. The value used for this API: ModifyNetworkConfig.
Version	Yes	String	Common parameter. The value used for this API: 2018-04-12.
Region	Yes	String	Common parameter. For more information, please see the list of regions supported by the product.
InstanceId	Yes	String	Instance ID
Operation	Yes	String	Operation type. changeVip: modify the VIP of an instance; changeVpc: modify the subnet of an instance; changeBaseToVpc: change from basic network to VPC
Vip	No	String	VIP address, which is required for the `changeVip` operation. If this parameter is left blank, a random one will be assigned by default
VpcId	No	String	VPC ID, which is required for `changeVpc` and `changeBaseToVpc` operations
SubnetId	No	String	Subnet ID, which is required for `changeVpc` and `changeBaseToVpc` operations

3. Output Parameters

Parameter Name	Type	Description
Status	Boolean	Execution status: true or false
SubnetId	String	Subnet ID
VpcId	String	VPC ID
Vip	String	VIP address
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Modifying the VIP of an instance

Input Example

https://redis.tencentcloudapi.com/?Action=ModifyNetworkConfig
&InstanceId=crs-5a4py64p
&Operation=changeVip
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "f1b5aabe-806a-4886-b839-9907baa24c85"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation.SystemError	Internal system error, which is irrelevant to the business.
FailedOperation.Unknown	Invalid data is entered for weekday.
InternalError.DbOperationFailed	Internal system error with the database operation, which may be update, insert, select, etc.
InternalError.InternalError	Internal error.
InvalidParameter	Incorrect parameter.
InvalidParameter.PermissionDenied	The API has no CAM permissions.
UnauthorizedOperation	Unauthorized operation.
UnauthorizedOperation.NoCAMAuthed	No CAM permissions.
UnauthorizedOperation.UserNotInWhiteList	The user is not in the allowlist.

Recent Pages