- Release Notes and Announcements
- User Guide
- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- Access Management
- Instance Management
- Node Management
- Node Overview
- Viewing Node Information
- Adjusting Mongod Node Specification
- Adding Secondary Node
- Deleting Secondary Node
- Adding Read-Only Node
- Adjusting Shard Quantity
- Adjusting Mongos Node Specification
- Adding Mongos Node
- Enabling Mongos Access Address
- Promoting Secondary Node to Primary Node
- Restarting a Node
- Version Upgrade
- Network Configuration
- Monitoring
- Backup and Rollback
- Data Security
- SSL Authentication
- Database Management
- Multi-AZ Deployment
- Disaster Recovery/Read-Only Instances
- Recycle Bin
- Task Management
- Performance Optimization
- Data Migration Guide
- Creating a DTS Migration Task
- Migration Overview
- Supported Capabilities
- User Guide
- Migration Operation Guide
- Fix for Verification Failure
- MongoDB Connection Check
- Database/Table Content Conflict Check
- Source Database Node Role Check
- Oplog Check
- Source/Target Database Account Permission Check
- Database Version Check
- Database Capacity Check
- Target Database Load Check
- ShardKey Check
- Source Database Balancer Check
- Time Series Collection Verification
- Compression Algorithm Verification
- Consistency Check After Migration
- Creating MongoDB Data Subscription
- Creating a DTS Migration Task
- Practical Tutorial
- Optimizing Indexes to Break Through Read/Write Performance Bottlenecks
- Troubleshooting Mongos Load Imbalance in Sharded Cluster
- Considerations for Using Shard Clusters
- Sample of Reading and Writing Data in MongoDB Instance
- Methods for Importing and Exporting Data Based on CVM Connected with MongoDB
- What to Do for Errors of Repeated Instance Creation and Deletion of Databases with the Same Names?
- Troubleshooting MongoDB Connection Failures
- Performance Fine-Tuning
- Ops and Development Guide
- Troubleshooting
- API Documentation
- History
- Introduction
- API Category
- Making API Requests
- Instance APIs
- RenameInstance
- OfflineIsolatedDBInstance
- ModifyDBInstanceSpec
- IsolateDBInstance
- DescribeSpecInfo
- DescribeDBInstances
- DescribeClientConnections
- CreateDBInstanceHour
- AssignProject
- RenewDBInstances
- DescribeSlowLogs
- DescribeSlowLogPatterns
- InquirePriceRenewDBInstances
- InquirePriceModifyDBInstanceSpec
- InquirePriceCreateDBInstances
- DescribeDBInstanceDeal
- DescribeSecurityGroup
- DescribeInstanceParams
- ModifyDBInstanceSecurityGroup
- ModifyDBInstanceNetworkAddress
- Backup APIs
- Account APIs
- Task APIs
- Other APIs
- Data Types
- Error Codes
- Instance Connection
- Product Performance
- FAQs
- Service Agreement
- Glossary
- Contact Us
- Release Notes and Announcements
- User Guide
- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- Access Management
- Instance Management
- Node Management
- Node Overview
- Viewing Node Information
- Adjusting Mongod Node Specification
- Adding Secondary Node
- Deleting Secondary Node
- Adding Read-Only Node
- Adjusting Shard Quantity
- Adjusting Mongos Node Specification
- Adding Mongos Node
- Enabling Mongos Access Address
- Promoting Secondary Node to Primary Node
- Restarting a Node
- Version Upgrade
- Network Configuration
- Monitoring
- Backup and Rollback
- Data Security
- SSL Authentication
- Database Management
- Multi-AZ Deployment
- Disaster Recovery/Read-Only Instances
- Recycle Bin
- Task Management
- Performance Optimization
- Data Migration Guide
- Creating a DTS Migration Task
- Migration Overview
- Supported Capabilities
- User Guide
- Migration Operation Guide
- Fix for Verification Failure
- MongoDB Connection Check
- Database/Table Content Conflict Check
- Source Database Node Role Check
- Oplog Check
- Source/Target Database Account Permission Check
- Database Version Check
- Database Capacity Check
- Target Database Load Check
- ShardKey Check
- Source Database Balancer Check
- Time Series Collection Verification
- Compression Algorithm Verification
- Consistency Check After Migration
- Creating MongoDB Data Subscription
- Creating a DTS Migration Task
- Practical Tutorial
- Optimizing Indexes to Break Through Read/Write Performance Bottlenecks
- Troubleshooting Mongos Load Imbalance in Sharded Cluster
- Considerations for Using Shard Clusters
- Sample of Reading and Writing Data in MongoDB Instance
- Methods for Importing and Exporting Data Based on CVM Connected with MongoDB
- What to Do for Errors of Repeated Instance Creation and Deletion of Databases with the Same Names?
- Troubleshooting MongoDB Connection Failures
- Performance Fine-Tuning
- Ops and Development Guide
- Troubleshooting
- API Documentation
- History
- Introduction
- API Category
- Making API Requests
- Instance APIs
- RenameInstance
- OfflineIsolatedDBInstance
- ModifyDBInstanceSpec
- IsolateDBInstance
- DescribeSpecInfo
- DescribeDBInstances
- DescribeClientConnections
- CreateDBInstanceHour
- AssignProject
- RenewDBInstances
- DescribeSlowLogs
- DescribeSlowLogPatterns
- InquirePriceRenewDBInstances
- InquirePriceModifyDBInstanceSpec
- InquirePriceCreateDBInstances
- DescribeDBInstanceDeal
- DescribeSecurityGroup
- DescribeInstanceParams
- ModifyDBInstanceSecurityGroup
- ModifyDBInstanceNetworkAddress
- Backup APIs
- Account APIs
- Task APIs
- Other APIs
- Data Types
- Error Codes
- Instance Connection
- Product Performance
- FAQs
- Service Agreement
- Glossary
- Contact Us
1. API Description
Domain name for API request: mongodb.tencentcloudapi.com.
This API is used to rename a TencentDB instance.
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: RenameInstance. |
| Version | Yes | String | Common Params. The value used for this API: 2019-07-25. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| InstanceId | Yes | String | Instance ID in the format of cmgo-p8vnipr5. It is the same as the instance ID displayed on the TencentDB Console page |
| NewName | Yes | String | Custom name of the instance, which can contain up to 60 letters, digits, or symbols (_-) |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Renaming a TencentDB instance
Input Example
https://mongodb.tencentcloudapi.com/?Action=RenameInstance
&InstanceId=cmgo-eqmoa5sf
&NewName=test_name
&<Common request parameters>
Output Example
{
"Response": {
"RequestId": "8e2a339e-5ba9-4da3-8dc2-65a0a6314811"
}
}
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 NodeJS
- 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 |
|---|---|
| InternalError | Internal error |
| InvalidParameter.PermissionDenied | The current subaccount has no permission to perform this operation. |
| InvalidParameterValue.IllegalInstanceName | Invalid instance name |
| InvalidParameterValue.InstanceHasBeenDeleted | The instance has been deleted. |
| InvalidParameterValue.InstanceHasBeenIsolated | The instance has been isolated. |
| InvalidParameterValue.NotFoundInstance | The instance was not found. |
Yes
No
Was this page helpful?