tencent cloud

Feedback

ModifyDBInstanceNetwork

Last updated: 2022-06-06 15:26:50

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.

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 Params. The value used for this API: ModifyDBInstanceNetwork.
Version Yes String Common Params. The value used for this API: 2018-03-28.
Region Yes String Common Params. 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.
Vip No String New VIP

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 Modifying the instance network

Input Example

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

Output Example

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

Example2 Modifying the instance network

Input Example

POST / HTTP/1.1
Host: sqlserver.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDBInstanceNetwork
<Common request parameters>

{
    "InstanceId": "mssql-e720ieef",
    "NewVpcId": "vpc-kw88teud",
    "NewSubnetId": "subnet-8z5n8tcg",
    "OldIpRetainTime": "0"
}

Output Example

{
  "Response": {
    "FlowId": 1011581,
    "RequestId": "bdac237c-b9b7-4050-9284-97898cca5883"
  }
}

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.DBError Database error.
FailedOperation.GcsError The operation failed or the network timed out.
FailedOperation.GetVpcFailed Failed to get VPC information.
FailedOperation.VPCError Failed to operate the network or the session timed out.
InternalError.CamAuthFailed CAM authentication request failed.
InternalError.CreateFlowFailed Failed to create flow.
InternalError.DBConnectError Database connection 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.InstanceNotFound The instance does not exist.
ResourceNotFound.VpcNotExist The VPC does not exist.
ResourceUnavailable.InstanceStatusInvalid Invalid instance status.
ResourceUnavailable.VpcNotExist VPC not found.
UnauthorizedOperation.PermissionDenied CAM authentication error.
UnknownParameter Unknown parameter error
UnsupportedOperation.NotSupportRepeat Repeated operations are not supported.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support