Help Center/ Relational Database Service/ API Reference/ API v3 (Recommended)/ DB Instance Management/ Querying TDE Status of a DB Instance (RDS for SQL Server)
Updated on 2025-12-09 GMT+08:00
View PDF
Share

Querying TDE Status of a DB Instance (RDS for SQL Server)

Function

This API is used to query the TDE status.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
  • If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

rds:instance:tde

permission_management

-

g:EnterpriseProjectId g:ResourceTag/<tag-key>

-

-

Constraints

This API supports only RDS for SQL Server instances.

URI

  • URI format

    GET /v3/{project_id}/instances/{instance_id}/tde-status

  • Parameter description
    Table 1 Parameter description

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Project ID of a tenant in a region.

    To obtain the value, see Obtaining a Project ID.

    instance_id

    Yes

    Instance ID.

Request

  • Parameter description

    None

  • URI example 
    GET https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin04/tde-status

Response

  • Normal response
    Table 2 Parameters

    Parameter

    Type

    Description

    instance_id

    String

    Instance ID.

    tde_status

    String

    TDE status.

    Enumerated values:

    • open: Enabled
    • close: Disabled
  • Example normal response 
    {
"instance_id":"3d39c18788b54a919bab633874c159dfin04",
"tde_status":"open"
}
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.

Parent topic: DB Instance Management