tencent cloud

Feedback

ModifyInstanceEncryptAttributes

Last updated: 2023-09-18 11:41:41

1. API Description

Domain name for API request: sqlserver.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 u200downership. 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, which is returned for each request. 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.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.

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.
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