tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeDBInstancesAttribute

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

1. API Description

Domain name for API request: sqlserver.tencentcloudapi.com.

This API is used to query the attributes 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: DescribeDBInstancesAttribute.
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

3. Output Parameters

Parameter Name Type Description
InstanceId String Instance ID
RegularBackupEnable String Archive backup status. Valid values: enable (enabled), disable (disabled)
RegularBackupSaveDays Integer Archive backup retention period: [90-3650] days
RegularBackupStrategy String Archive backup policy. Valid values: years (yearly); quarters (quarterly); months` (monthly).
RegularBackupCounts Integer The number of retained archive backups
RegularBackupStartTime String Archive backup start date in YYYY-MM-DD format, which is the current time by default.
BlockedThreshold Integer Block process threshold in milliseconds
EventSaveDays Integer Retention period for the files of slow SQL, blocking, deadlock, and extended events.
TDEConfig TDEConfigAttribute TDE u200dconfiguration
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the attributes of the "mssql-j8kv137v" instance

This example shows you how to query the attributes of an instance.

Input Example

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

{
    "InstanceId": "mssql-j8kv137v"
}

Output Example

{
    "Response": {
        "InstanceId": "mssql-j8kv137v",
        "RegularBackupSaveDays": 1,
        "RequestId": "7",
        "RegularBackupCounts": 1,
        "RegularBackupEnable": "enable",
        "RegularBackupStrategy": "months",
        "RegularBackupStartTime": "2022-10-10",
        "EventSaveDays": 0,
        "TDEConfig": {
            "Encryption": "disable",
            "CertificateAttribution": "self",
            "QuoteUin": ""
        },
        "BlockedThreshold": 6
    }
}

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.DBError Database error.
FailedOperation.GcsError The operation failed or the network timed out.
InternalError.UnknownError Unknown error.
InvalidParameter.ParamsAssertFailed An error occurred while converting parameter assertion.
ResourceNotFound.InstanceNotFound The instance does not exist.
UnauthorizedOperation.PermissionDenied CAM authentication error.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy