DescribeDBInstanceSSL - ApsaraDB RDS: Central de Documentação do Alibaba Cloud

Consulta a configuração SSL de uma instância do ApsaraDB RDS.

Descrição da operação

Mecanismos aplicáveis

RDS MySQL
RDS PostgreSQL
RDS SQL Server

Documentação relacionada

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

rds:DescribeDBInstanceSSL

get

*DBInstance

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

rds:ResourceTag
rds:ResourceTag
rds:ResourceTag
rds:ResourceTag

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DBInstanceId	string	Sim	O ID da instância. Você pode chamar DescribeDBInstances para obter o ID da instância.	rm-bp162dfr55g47****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
ACL	string	O método de autenticação da instância do ApsaraDB RDS for PostgreSQL com discos em nuvem. Valores válidos: cert prefer verify-ca verify-full (suportado para RDS PostgreSQL 12 e versões posteriores)	cert
CAType	string	O tipo de certificado do servidor da instância do ApsaraDB RDS for PostgreSQL com discos em nuvem. Valores válidos: aliyun: Usa um certificado em nuvem. custom: Usa um certificado personalizado.	aliyun
ClientCACert	string	A chave pública da autoridade certificadora (CA) do cliente para a instância do ApsaraDB RDS for PostgreSQL com discos em nuvem.	-----BEGIN CERTIFICATE-----MIID*****viXk=-----END CERTIFICATE-----
ClientCACertExpireTime	string	O horário de expiração da chave pública de autorização do certificado do cliente para a instância do ApsaraDB RDS for PostgreSQL com discos em nuvem. O horário segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. O horário é exibido em UTC.	-
ClientCertRevocationList	string	O arquivo de certificado de revogação do cliente para a instância do ApsaraDB RDS for PostgreSQL com discos em nuvem.	-----BEGIN X509 CRL-----MIIB****19mg==-----END X509 CRL-----
ConnectionString	string	O endpoint protegido por SSL.	rm-bp162dfr55g47****.mysql.rds.aliyuncs.com
ForceEncryption	string	Indica se o recurso de criptografia forçada de Secure Sockets Layer (SSL) está ativado para a instância do ApsaraDB RDS for SQL Server. Valores válidos:	1
LastModifyStatus	string	O status atual da configuração do link SSL da instância ApsaraDB RDS for PostgreSQL com discos em nuvem. Valores válidos: success: A configuração foi bem-sucedida. setting: A configuração está em andamento. failed: A configuração falhou.	setting
ModifyStatusReason	string	O motivo do status atual da configuração do link SSL da instância do ApsaraDB RDS for PostgreSQL com discos em nuvem.	Modificar configuração SSL da instância de banco de dados
ReplicationACL	string	O método de autenticação para permissões de replicação de uma instância do ApsaraDB RDS for PostgreSQL com discos em nuvem. Valores válidos: cert prefer verify-ca verify-full (suportado pelo RDS PostgreSQL 12 e versões posteriores)	cert
RequestId	string	O ID da solicitação.	7705151C-E242-55AF-9929-2A3C39D979D2
RequireUpdate	string	Indica se o certificado SSL precisa ser atualizado. Valores válidos: Nota Um certificado SSL é válido por um ano. Se o certificado não for atualizado após a expiração, programas cliente que utilizam conexões criptografadas não conseguirão se conectar à instância. MySQL, SQL Server No: Nenhuma atualização é necessária. Yes: Uma atualização é necessária. PostgreSQL 0: Nenhuma atualização é necessária. 1: Uma atualização é necessária.	Yes
RequireUpdateItem	string	A lista de certificados de servidor que precisam ser atualizados para a instância do ApsaraDB RDS for PostgreSQL com discos em nuvem.	-
RequireUpdateReason	string	O motivo pelo qual os certificados precisam ser atualizados para a instância do ApsaraDB RDS for PostgreSQL com discos em nuvem.	-
SSLCreateTime	string	O horário de criação do certificado do servidor para a instância do ApsaraDB RDS for PostgreSQL com discos em nuvem. Este parâmetro é válido apenas quando CAType está definido como aliyun.	-
SSLEnabled	string	O status de criptografia SSL. Valores válidos: MySQL e SQL Server Yes: A criptografia SSL está ativada. No: A criptografia SSL está desativada. PostgreSQL on: A criptografia SSL está ativada. off: A criptografia SSL está desativada.	Yes
SSLExpireTime	string	O horário de expiração do certificado SSL. O horário segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. O horário é exibido em UTC.	2025-06-16T08:16:43Z
ServerCAUrl	string	A URL do certificado CA usado para emitir o certificado do servidor para a instância do ApsaraDB RDS for PostgreSQL com discos em nuvem.	-
ServerCert	string	O conteúdo do certificado do servidor para a instância do ApsaraDB RDS for PostgreSQL com discos em nuvem.	-----BEGIN CERTIFICATE-----MIID*****QqEP-----END CERTIFICATE-----
ServerKey	string	A chave privada do certificado do servidor para a instância do ApsaraDB RDS for PostgreSQL com discos em nuvem.	-----BEGIN PRIVATE KEY-----MIIE****ihfg==-----END PRIVATE KEY-----
TlsVersion	string	A versão TLS mínima especificada para a instância do ApsaraDB RDS for SQL Server. Valores válidos: 1.0, 1.1 e 1.2.	1.1

Exemplos

Resposta de sucesso

JSON formato

{
  "ACL": "cert",
  "CAType": "aliyun",
  "ClientCACert": "-----BEGIN CERTIFICATE-----MIID*****viXk=-----END CERTIFICATE-----",
  "ClientCACertExpireTime": "-",
  "ClientCertRevocationList": "-----BEGIN X509 CRL-----MIIB****19mg==-----END X509 CRL-----",
  "ConnectionString": "rm-bp162dfr55g47****.mysql.rds.aliyuncs.com",
  "ForceEncryption": "1",
  "LastModifyStatus": "setting",
  "ModifyStatusReason": "Modificar configuração SSL da instância de banco de dados",
  "ReplicationACL": "cert",
  "RequestId": "7705151C-E242-55AF-9929-2A3C39D979D2",
  "RequireUpdate": "Yes",
  "RequireUpdateItem": "-",
  "RequireUpdateReason": "-",
  "SSLCreateTime": "-",
  "SSLEnabled": "Yes",
  "SSLExpireTime": "2025-06-16T08:16:43Z",
  "ServerCAUrl": "-",
  "ServerCert": "-----BEGIN CERTIFICATE-----MIID*****QqEP-----END CERTIFICATE-----",
  "ServerKey": "-----BEGIN PRIVATE KEY-----MIIE****ihfg==-----END PRIVATE KEY-----",
  "TlsVersion": "1.1"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvaildEngineInRegion.ValueNotSupported	The engine is not supported in the region.	A versão do banco de dados está incorreta.
400	InvalideStatus.Format	Specified Status is not valid.
400	ConcurrentLimit	The request processing has been concurrent limit.	O processamento da solicitação atingiu o limite de simultaneidade.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.	Operações individuais não são permitidas para instâncias de pacote.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.	O resultado do preço do plano de precificação não foi encontrado.
400	Order.NoRealNameAuthentication	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.	Você não concluiu a verificação de nome real e não está elegível para realizar uma compra. Faça login em Despesas e Custos para concluir a verificação de nome real.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.	O crédito disponível da sua conta é menor que 0. Recarregue sua conta antes de tentar realizar a compra.
400	CommodityServiceCalling.Exception	Failed to call commodity service.	A chamada ao serviço de commodity falhou.
400	RegionDissolvedEOM	Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.	O Alibaba Cloud planeja otimizar e ajustar a região atual. Os serviços em nuvem nesta região serão descontinuados. Para garantir a continuidade dos seus negócios e uma migração de dados tranquila, você não pode fazer novos pedidos de compra no momento. Agradecemos sua compreensão e apoio.
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.	O módulo adquirido é inválido. Adquira um módulo válido.
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.	A região foi desativada.
400	Price.CommoditySys	Commodity system call exception.	Ocorreu uma exceção ao chamar o sistema de commodities.
400	Pay.InsufficientBalance	Insufficient available balance.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.	O período de assinatura selecionado é inválido. Selecione um período válido.
400	pay.noCreditCard	Account not bound to credit card.	Nenhum cartão de crédito disponível.
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.	Existe um pedido não pago para o serviço selecionado. Pague ou cancele o pedido existente antes de fazer um novo.
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.	Nenhum método de pagamento está especificado para a conta. Adicione um método de pagamento.
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.	Suas informações básicas estão incompletas. Complete suas informações básicas antes de realizar esta operação.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.	Ocorreu uma exceção na sua conta. Entre em contato com o atendimento ao cliente para obter detalhes.
400	Api.NotSupport	Specified api is not supported.	A operação de API atual não é suportada.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.	Existe uma tag de bloqueio de pedido. Entre em contato com seu distribuidor para resolver este problema.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.	O DBInstanceId especificado não existe.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type	O tipo de instância atual não suporta o tipo de armazenamento especificado.
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.	O parâmetro de entrada é inválido.
400	KmsApiError	User secret key invalid.	A chave do usuário é inválida.
400	System.SaleValidateFailed	Sales expression validation system error.
400	Abs.InvalidAccount.NotFound	account is not found.	Sua conta Alibaba Cloud não existe ou seu AccessKey expirou.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.	A execução do comando SQL falhou ou expirou.
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.	A versão atual do mecanismo DPI da instância não suporta arquivamento de dados frios.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.	A versão atual do kernel não suporta arquivamento de dados frios.
400	IncorrectTargetClasscode	The current instance type does not support this operation.	A especificação atual da instância não suporta esta operação.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.	O nome do endereço de conexão está duplicado. Defina a string de conexão novamente.
400	RequiredParam.NotFound	Required input param is not found.	Parâmetros obrigatórios estão ausentes.
400	Parameters.Invalid	Parameter error, please check the parameters.	O parâmetro está incorreto. Verifique o parâmetro.
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.	A política de backup atual não suporta esta operação.
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.	A política de retenção de dados de backup de arquivamento após a liberação da instância é inválida.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.	O tipo de mecanismo de banco de dados da instância não suporta esta operação.
400	Pay.NoCreditCard	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.	Esta operação não é suportada para instâncias com o tipo de rede VPC.
400	MirrorInsExists	Specified DB instance mirror ins already existed.	A imagem da instância de banco de dados atual já existe.
400	UnsupportedClassCode	The specified DB instance class stops selling.	O tipo de instância não está mais disponível para compra.
400	InvalidBackupSet	The specified database does not exist in the backup set.	O banco de dados especificado não existe no conjunto de backup.
400	OrdTCommodityQueryError	Failed to query for product.	Falha ao consultar o produto.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.	A instância foi liberada. Verifique a instância antes de fazer o pedido.
400	RegionEndTimeDissolvedIndia	The region is no longer supported.	A região especificada é inválida.
500	ExternalFailure	The request processing has failed due to external service failure.	A solicitação ao serviço falhou. Tente novamente mais tarde.
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.	A solicitação de serviço falhou. Tente novamente mais tarde ou entre em contato com o suporte.
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.	O processamento da solicitação falhou devido a uma falha no serviço de API do RDS.
403	OperationDenied.DBInstanceType	The operation is not permitted due to type of the instance.	A operação falhou. Instâncias somente leitura não suportam clonagem. Verifique o tipo de instância.
403	InstanceEngineType.NotSupport	The instance engine and type does not support operations	O mecanismo e o tipo da instância ApsaraDB RDS for MySQL não suportam esta operação. Verifique se o kindcode ou a versão secundária do mecanismo da instância é muito baixa e atualize a versão secundária do mecanismo.
403	IncorrectEngineVersion	Current engine version does not support operations.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.	O status atual da instância não suporta esta operação.
403	IncorrectDBInstanceType	Current DB instance type does not support this operation.	A operação falhou. Esta operação não é suportada no status atual da instância.
403	IncorrectDBInstanceLockMode	Current DB instance lock mode does not support this operation.
403	ConnectionStringLengthExceeded	Connection String is too long.	A string de conexão é muito longa. Modifique-a e tente novamente.
403	ResourceConfigError	The request processing has failed due to resource config error.	A solicitação falhou devido a um erro de configuração de recurso.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.	Existe um pedido não pago para a instância atual. Pague o pedido e tente novamente.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.	A capacidade de destino para redução de escala não pode ser menor que o uso atual de armazenamento.
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.	Os discos SSD não suportam esta operação. Atualize para ESSD.
403	InvalidUserOperatorPermission	The user permission does not support this operation.	As permissões do usuário não oferecem suporte a esta operação.
403	InvalidVswitchId	Specified conn vswitch id is not valid.	O VSwitchId especificado está em um formato incorreto ou está vazio.
403	IncorrectMinorVersion	Current engine minor version does not support operations.	A versão secundária do mecanismo atual não suporta esta operação.
403	OperationDenied.ZoneResource	There is no available zone for inventory.	Não existem regiões de inventário disponíveis.
403	NotInFlowController	Sorry,no permission.	Este recurso está indisponível. Você não tem permissão porque não é um usuário de nuvem corporativa.
403	InvalidKmsKey	Kms key is disabled.	A chave KMS está desativada.
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.	O nível atual da instância de banco de dados não suporta esta operação.
403	GuardDBInstanceNotSupport	Guard instance does not support this operation.	Esta operação não é suportada para instâncias de recuperação de desastres.
404	InvalidDBInstanceId.NotFound	The specified instance is not found.	O DBInstanceId especificado não existe.
404	EnabledSSLNotSupport	Specified region does not support enable ssl.	A região especificada não suporta a ativação do serviço SSL.
404	InvalidConnectionString.NotFound	Specified connection string or net type is not found.	A string de conexão não existe. Verifique se a string de conexão está correta.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.	A instância atual não está autorizada a acessar o Key Management Service.
404	Request.NotFound	The requested resource is not available.	O recurso solicitado não está disponível.
404	HostInfo.NotFound	The specified host info is not found.	As informações do host especificado não existem.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.