- Release Notes and Announcements
- Release Notes
- Announcements
- Announcement on Changing External Network Links
- Interface Authentication Upgrade Announcement
- Maintenance Time Change from Local Time to Beijing Time
- Account Type and Permission Changes
- Product Architecture Name Change
- Disk Storage Space Composition Change
- Ending Support for Classic Network [2022.12.31]
- Backup Billing Start [2022.07.10]
- Ending Sale for Basic Edition 1-Core Specification [2022.03.07]
- User Guide
- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- Constraints and Limits
- Usage Specifications and Suggestions
- Maintaining Instance
- Renaming Instance
- Setting Instance Remarks
- Setting Instance Tag
- Setting Instance Project
- Modify Instance-level Character Set Collation
- Modify System Time Zone
- Setting Instance Maintenance Information
- Multi-AZ Disaster Recovery
- Restarting Instance
- Terminating Instance
- Migrating Across AZs
- Manual Primary-Secondary Switching
- Recycle Bin
- Adjusting Instance Configuration
- Read-Only Instance
- Network and Security
- Account Management
- Database Management
- Data Security
- Parameter Configuration
- Monitoring and Alarms
- Backup and Restoration
- Log Management
- Publish-Subscribe
- SSIS
- Data Migration (New)
- Data Migration (Legacy)
- Practical Tutorial
- API Documentation
- History
- Introduction
- API Category
- 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
- Backup APIs
- Rollback APIs
- Data migration (cold standby migration) related APIs
- CreateBackupMigration
- ModifyBackupMigration
- StartBackupMigration
- DescribeBackupMigration
- DeleteBackupMigration
- DescribeUploadBackupInfo
- CreateIncrementalMigration
- ModifyIncrementalMigration
- StartIncrementalMigration
- DescribeIncrementalMigration
- DescribeBackupCommand
- DescribeBackupUploadSize
- DeleteIncrementalMigration
- Data migration (DTS old version) related APIs
- Making API Requests
- Database APIs
- Other APIs
- Data Types
- Error Codes
- FAQs
- Overview
- Model Selection
- Pricing and Selection
- Connection and Network
- Account and Permission
- Backup and Rollback
- Data Migration
- Publish/Subscribe
- Read-Only Instance
- Version and Architecture Upgrade
- Disk Space and Specification Adjustment
- Monitoring and Alarms
- Log
- Parameter Modification
- Features
- Performance/Space/Memory
- Service Agreement
- Performance Evaluation
- Glossary
- Contact Us
- Release Notes and Announcements
- Release Notes
- Announcements
- Announcement on Changing External Network Links
- Interface Authentication Upgrade Announcement
- Maintenance Time Change from Local Time to Beijing Time
- Account Type and Permission Changes
- Product Architecture Name Change
- Disk Storage Space Composition Change
- Ending Support for Classic Network [2022.12.31]
- Backup Billing Start [2022.07.10]
- Ending Sale for Basic Edition 1-Core Specification [2022.03.07]
- User Guide
- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- Constraints and Limits
- Usage Specifications and Suggestions
- Maintaining Instance
- Renaming Instance
- Setting Instance Remarks
- Setting Instance Tag
- Setting Instance Project
- Modify Instance-level Character Set Collation
- Modify System Time Zone
- Setting Instance Maintenance Information
- Multi-AZ Disaster Recovery
- Restarting Instance
- Terminating Instance
- Migrating Across AZs
- Manual Primary-Secondary Switching
- Recycle Bin
- Adjusting Instance Configuration
- Read-Only Instance
- Network and Security
- Account Management
- Database Management
- Data Security
- Parameter Configuration
- Monitoring and Alarms
- Backup and Restoration
- Log Management
- Publish-Subscribe
- SSIS
- Data Migration (New)
- Data Migration (Legacy)
- Practical Tutorial
- API Documentation
- History
- Introduction
- API Category
- 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
- Backup APIs
- Rollback APIs
- Data migration (cold standby migration) related APIs
- CreateBackupMigration
- ModifyBackupMigration
- StartBackupMigration
- DescribeBackupMigration
- DeleteBackupMigration
- DescribeUploadBackupInfo
- CreateIncrementalMigration
- ModifyIncrementalMigration
- StartIncrementalMigration
- DescribeIncrementalMigration
- DescribeBackupCommand
- DescribeBackupUploadSize
- DeleteIncrementalMigration
- Data migration (DTS old version) related APIs
- Making API Requests
- Database APIs
- Other APIs
- Data Types
- Error Codes
- FAQs
- Overview
- Model Selection
- Pricing and Selection
- Connection and Network
- Account and Permission
- Backup and Rollback
- Data Migration
- Publish/Subscribe
- Read-Only Instance
- Version and Architecture Upgrade
- Disk Space and Specification Adjustment
- Monitoring and Alarms
- Log
- Parameter Modification
- Features
- Performance/Space/Memory
- Service Agreement
- Performance Evaluation
- Glossary
- Contact Us
1. API Description
Domain name for API request: sqlserver.intl.tencentcloudapi.com.
This API is used to enable TDE of an 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: ModifyInstanceEncryptAttributes. |
| 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 |
| CertificateAttribution | Yes | String | Certificate ownership. Valid values: self (certificate of this account), others (certificate of the other account). Default value: self. |
| QuoteUin | No | String | ID of the other referenced root account, which is required when CertificateAttribution is others. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| FlowId | Integer | Task flow ID |
| 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 Enabling TDE of an instance
This example shows you how to enable TDE of an instance.
Input Example
POST / HTTP/1.1
Host: sqlserver.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyInstanceEncryptAttributes
<Common request parameters>
{
"InstanceId": "mssql-njj2mtpl",
"CertificateAttribution": "self",
"QuoteUin": ""
}
Output Example
{
"Response": {
"FlowId": 12098283,
"RequestId": "5062de55-d048-4d3b-92f9-b98b6f244360"
}
}
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 |
|---|---|
| FailedOperation.NotSupport | The operation is not supported. |
| ResourceNotFound.InstanceNotFound | The instance does not exist. |
| ResourceUnavailable.InstanceStatusInvalid | Invalid instance status. |
| UnsupportedOperation.NotSupportRepeat | Repeated operations are not supported. |
Yes
No
Was this page helpful?