TencentDB for SQL Server
- Release Notes and Announcements
- Announcements
- Product Introduction
- Product Architecture
- Instance Specifications
- Purchase Guide
- Product Pricing
- Getting Started
- Connecting to TencentDB for SQL Server Instance
- Operation Guide
- Maintaining Instance
- Adjusting Instance Configuration
- Read-Only Instance
- Network and Security
- Account Management
- Database Management
- Data Security
- Access Management
- Parameter Configuration
- Monitoring and Alarms
- Backup and Restoration
- Backup
- Setting Automatic Backup
- Log Management
- Publish-Subscribe
- SSIS
- Data Migration (New)
- Using DTS to Migrate Data
- Pre-Validation Failure Handling
- Data Migration (Legacy)
- Migrating Data from SQL Server Instance Purchased at Other Cloud Service Provider or Built In-house
- Practical Tutorial
- API Documentation
- Sales and fee related APIs
- Network management related APIs
- Account management related APIs
- Instance Management APIs
- Data security encryption related APIs
- Parameter configuration related APIs
- Log management related APIs
- Extended Event APIs
- Read only instance management related APIs
- Data migration (cold standby migration) related APIs
- Data migration (DTS old version) related APIs
- Making API Requests
- Database APIs
- Other APIs
- FAQs
- Service Agreement
- Performance Evaluation
DocumentationTencentDB for SQL ServerAPI DocumentationNetwork management related APIsModifyDBInstanceNetwork
ModifyDBInstanceNetwork
Last updated: 2024-11-26 16:33:14
1. API Description
Domain name for API request: sqlserver.intl.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 |
| DRNetwork | No | Integer |
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, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Network Change
Input Example
POST / HTTP/1.1
Host: sqlserver.intl.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": {
"RequestId": "20db6661-2a85-49d9-8a37-976b931649fb",
"FlowId": 100125
}
}
Example2 Instance Network Modification
Input Example
https://sqlserver.intl.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": {
"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.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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. |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No