ModifyDBInstanceNetwork

Last updated: 2021-02-05 14:17:55

1. API Description

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

This API is used to switch a running instance from a VPC to another.

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: sqlserver.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: ModifyDBInstanceNetwork.
Version Yes String Common parameter. The value used for this API: 2018-03-28.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
InstanceId Yes String Instance ID
NewVpcId Yes String ID of the new VPC
NewSubnetId Yes String ID of the new subnet
OldIpRetainTime No Integer Retention period (in hours) of the original VIP. Value range: 0-168. Default value: 0, indicating the original VIP is released immediately.

3. Output Parameters

Parameter Name Type Description
FlowId Integer ID of the instance network changing task. You can use the DescribeFlowStatus API to query the task status.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Changing instance network

Input Example

https://sqlserver.tencentcloudapi.com/?Action=ModifyDBInstanceNetwork
&InstanceId=mssql-p2yli7gv
&NewVpcId=vpc-ilki4qdp
&NewSubnetId=subnet-lru6dhh8
&OldIpRetainTime=12
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "20db6661-2a85-49d9-8a37-976b931649fb",
    "FlowId": 100125
  }
}

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

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
AuthFailure CAM signature/authentication error
FailedOperation.GetVpcFailed Failed to get VPC information.
InternalError Internal error.
InternalError.CamAuthFailed CAM authentication request failed.
InternalError.CreateFlowFailed Failed to create flow.
InternalError.DBConnectError Database connection error.
InternalError.DBError Database error
InternalError.GcsError GCS API error.
InternalError.SystemError System error.
InternalError.UnknownError Unknown error.
InternalError.VPCError VPC error
InvalidParameter Invalid parameter.
InvalidParameter.InputIllegal Input error.
InvalidParameter.ParamsAssertFailed An error occurred while converting parameter assertion.
InvalidParameterValue The parameter value is invalid.
ResourceNotFound Resource not found.
ResourceNotFound.VpcNotExist The VPC does not exist.
ResourceUnavailable.VpcNotExist VPC not found.
UnauthorizedOperation.PermissionDenied CAM authentication error.
UnknownParameter Unknown parameter error

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help