Tüm Ürünler
Search

Bu Ürün

    :DescribeDBInstanceEncryptionKey

    Belge Merkezi

    :DescribeDBInstanceEncryptionKey

    Son Güncelleme:Oct 13, 2026

    Bir MongoDB örneğine ait belirli bir anahtarın ayrıntılarını sorgular.

    Operation description

    DescribeDBInstanceEncryptionKey işlemini çağırdığınızda, örnek için Kendi Anahtarını Getir (BYOK) kullanılarak saydam veri şifrelemesinin (TDE) etkinleştirilmiş olması gerekir. TDE'yi etkinleştirmek için ModifyDBInstanceTDE işlemini çağırabilirsiniz.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    dds:DescribeDBInstanceEncryptionKey

    get

    *Instance

    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DBInstanceId

    string

    Yes

    Örnek kimliği.

    dds-bp2235****
    EncryptionKey

    string

    No

    Örneğin özel şifreleme anahtarı. Örneğin özel anahtarlarını sorgulamak için DescribeUserEncryptionKeyList işlemini çağırabilirsiniz.

    2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

    Response elements

    Element

    Type

    Description

    Example

    object

    Yanıt verileri.

    Creator

    string

    Anahtarı oluşturan kullanıcının UID'si.

    123456
    DeleteDate

    string

    Örnek anahtarının planlanan silinme zamanı. Bu değer boşsa, anahtar otomatik olarak silinmez.

    2020-07-06T18:22:03Z
    Description

    string

    Örnek anahtarının açıklaması.

    key description example
    EncryptionKey

    string

    Örnek anahtarı.

    2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    EncryptionKeyStatus

    string

    Örnek anahtarının durumu. Geçerli değerler:

    • Enabled: Örnek anahtarı kullanılabilir.

    • Disabled: Örnek anahtarı kullanılamaz.

    Enabled
    KeyUsage

    string

    Örnek anahtarının kullanım amacı.

    ENCRYPT/DECRYPT
    MaterialExpireTime

    string

    Anahtarın sona erme zamanı (UTC). Bu değer boşsa, anahtarın süresi dolmaz.

    2020-07-06T18:22:03Z
    Origin

    string

    Örnek anahtarının kaynağı.

    Aliyun_KMS
    RequestId

    string

    İsteğin kimliği.

    783C2062-A2D3-4EA8-88AD-E43F990C23BB

    Examples

    Success response

    JSON format

    {
  "Creator": "123456",
  "DeleteDate": "2020-07-06T18:22:03Z",
  "Description": "key description example",
  "EncryptionKey": "2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "EncryptionKeyStatus": "Enabled",
  "KeyUsage": "ENCRYPT/DECRYPT",
  "MaterialExpireTime": "2020-07-06T18:22:03Z",
  "Origin": "Aliyun_KMS",
  "RequestId": "783C2062-A2D3-4EA8-88AD-E43F990C23BB"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    403 INVALID_INSNAME_REGIONID_EMPTY The insName and regionId can't be all empty
    403 NO_ACTIVE_BYOK This custins no active byok.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.