Consultar o status e a chave de criptografia de disco - : Central de Documentação do Alibaba Cloud

Use a operação DescribeDBInstanceEncryptionKey para verificar se a criptografia de disco está ativada em uma instância com SSDs padrão ou SSDs aprimorados (ESSDs). Essa operação também consulta os detalhes da chave de criptografia e é compatível com instâncias MySQL, SQL Server ou PostgreSQL.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeDBInstanceEncryptionKey	A operação a ser executada. Defina o valor como DescribeDBInstanceEncryptionKey.
RegionId	String	Não	cn-hangzhou	O ID da região da instância. Chame a operação DescribeRegions para obter a lista de regiões mais recente.
DBInstanceId	String	Sim	rm-uf6wjk5xxxxxxx	O ID da instância. Use a operação DescribeDBInstances para consultar esse ID.
EncryptionKey	String	Não	749c1df7-xxxx-xxxx-xxxx-xxxxxxxxxxxx	O ID da chave personalizada.
TargetRegionId	String	Não	cn-qingdao	O ID da região de destino. Chame a operação DescribeRegions para obter a lista de regiões mais recente.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
DeleteDate	String	2022-05-08T08:14:16Z	Data agendada para exclusão da chave. Segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ, exibido em UTC.
RequestId	String	3BC2768E-DEDA-40FC-BBE9-6B884F3626AF	ID da solicitação.
Description	String	Description of the key	Descrição da chave.
Origin	String	Aliyun_KMS	Origem da chave.
MaterialExpireTime	String	2021-10-18T08:14:16Z	Momento de expiração da chave. Segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ, exibido em UTC.
EncryptionKeyStatus	String	Enabled	Status da chave. Valores válidos: Enabled Disabled
KeyUsage	String	ENCRYPT/DECRYPT	Finalidade da chave.
EncryptionKey	String	5306d1b6-7fd3-42d9-9511-xxxxxxx	ID da chave.
Creator	String	1443*****9604	Usuário que criou a chave.
EncryptionKeyList	Array of EncryptionKeyInfo		Detalhes da chave.
KeyType	String	ALIAS	Tipo da chave.
EncryptionKey	String	5306d1b6-7fd3-42d9-9511-xxxxxxx	ID da chave.
Description	String	Description of the key	Descrição da chave.
KeyUsage	String	ENCRYPT/DECRYPT	Finalidade da chave.
DeleteDate	String	2022-05-08T08:14:16Z	Data agendada para exclusão da chave. Segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ, exibido em UTC.
Creator	String	1443*****9604	Usuário que criou a chave.
EncryptionKeyStatus	String	Enabled	Status da chave. Valores válidos: Enabled Disabled
Origin	String	Aliyun_KMS	Origem da chave.
MaterialExpireTime	String	2021-10-18T08:14:16Z	Momento de expiração da chave. Segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ, exibido em UTC.
AliasName	String	alias/xxx	Alias da chave.
UsedBy	String	master	Função da instância. Valores válidos: Master: instância primária slave: instância somente leitura

Exemplos

Solicitações de exemplo

http(s)://rds.aliyuncs.com/?Action=DescribeDBInstanceEncryptionKey
&RegionId=cn-hangzhou
&DBInstanceId=rm-uf6wjk5xxxxxxx
&EncryptionKey=749c1df7-xxxx-xxxx-xxxx-xxxxxxxxxxxx
&TargetRegionId=cn-qingdao
&Common request parameters

Respostas de sucesso de exemplo

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDBInstanceEncryptionKeyResponse>
    <DeleteDate>2022-05-08T08:14:16Z</DeleteDate>
    <RequestId>3BC2768E-DEDA-40FC-BBE9-6B884F3626AF</RequestId>
    <Description>Description of the key</Description>
    <Origin>Aliyun_KMS</Origin>
    <MaterialExpireTime>2021-10-18T08:14:16Z</MaterialExpireTime>
    <EncryptionKeyStatus>Enabled</EncryptionKeyStatus>
    <KeyUsage>ENCRYPT/DECRYPT</KeyUsage>
    <EncryptionKey>5306d1b6-7fd3-42d9-9511-xxxxxxx</EncryptionKey>
    <Creator>1443*****9604</Creator>
    <EncryptionKeyList>
        <KeyType>ALIAS</KeyType>
        <EncryptionKey>5306d1b6-7fd3-42d9-9511-xxxxxxx</EncryptionKey>
        <Description>Description of the key</Description>
        <KeyUsage>ENCRYPT/DECRYPT</KeyUsage>
        <DeleteDate>2022-05-08T08:14:16Z</DeleteDate>
        <Creator>1443*****9604</Creator>
        <EncryptionKeyStatus>Enabled</EncryptionKeyStatus>
        <Origin>Aliyun_KMS</Origin>
        <MaterialExpireTime>2021-10-18T08:14:16Z</MaterialExpireTime>
        <AliasName>alias/xxx</AliasName>
        <UsedBy>master</UsedBy>
    </EncryptionKeyList>
</DescribeDBInstanceEncryptionKeyResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "DeleteDate" : "2022-05-08T08:14:16Z",
  "RequestId" : "3BC2768E-DEDA-40FC-BBE9-6B884F3626AF",
  "Description" : "Description of the key",
  "Origin" : "Aliyun_KMS",
  "MaterialExpireTime" : "2021-10-18T08:14:16Z",
  "EncryptionKeyStatus" : "Enabled",
  "KeyUsage" : "ENCRYPT/DECRYPT",
  "EncryptionKey" : "5306d1b6-7fd3-42d9-9511-xxxxxxx",
  "Creator" : "1443*****9604",
  "EncryptionKeyList" : [ {
    "KeyType" : "ALIAS",
    "EncryptionKey" : "5306d1b6-7fd3-42d9-9511-xxxxxxx",
    "Description" : "Description of the key",
    "KeyUsage" : "ENCRYPT/DECRYPT",
    "DeleteDate" : "2022-05-08T08:14:16Z",
    "Creator" : "1443*****9604",
    "EncryptionKeyStatus" : "Enabled",
    "Origin" : "Aliyun_KMS",
    "MaterialExpireTime" : "2021-10-18T08:14:16Z",
    "AliasName" : "alias/xxx",
    "UsedBy" : "master"
  } ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
403	NoActiveBYOK	This custins no active byok.	Erro retornado quando o recurso Bring Your Own Key (BYOK) está desativado na instância.

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.