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

Descrição da operação

Para usar esta operação, a instância deve atender aos seguintes requisitos:

O status da instância é Running.
A instância é uma instância de conjunto de réplicas ou uma instância de cluster fragmentado.
- A instância de conjunto de réplicas deve ser da versão 3.4 ou posterior.
- A instância de cluster fragmentado deve usar Enhanced SSDs (ESSDs).

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

dds:DescribeDBInstanceSSL

get

*Instance

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DBInstanceId	string	Sim	O ID da instância.	dds-bpxxxxxxxx

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
SSLExpiredTime	string	A hora de expiração do certificado SSL. A hora está no formato yyyy-MM-ddTHH:mm:ssZ e é exibida em UTC.	2020-03-11T02:28:25Z
SSLStatus	string	O status do recurso SSL. Open: O recurso SSL está ativado. Closed: O recurso SSL está desativado.	Open
RequestId	string	O ID da solicitação.	36BB1BC2-789C-4BBA-A519-C5B388E4B0D4
CertCommonName	string	O nome do certificado SSL.	dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com
ForceEncryption	string	Especifica se as conexões devem ser criptografadas usando SSL. Valores válidos: 1: As conexões devem ser criptografadas usando SSL. 0: As conexões não precisam ser criptografadas usando SSL. Valores válidos: 0 : 0 1 : 1	0

Exemplos

Resposta de sucesso

JSON formato

{
  "SSLExpiredTime": "2020-03-11T02:28:25Z",
  "SSLStatus": "Open",
  "RequestId": "36BB1BC2-789C-4BBA-A519-C5B388E4B0D4",
  "CertCommonName": "dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com",
  "ForceEncryption": "0"
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.