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

Descrição da operação

Os tipos de instância que suportam a modificação do endpoint e da porta são os seguintes:\n- Você pode modificar os endpoints de instâncias com discos locais e discos em nuvem.\n- Para instâncias de cluster fragmentado, você pode modificar apenas os endpoints dos nós Mongos.

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:ModifyDBInstanceConnectionString

update

*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.\n\n> Se você especificar o ID de uma instância de cluster fragmentado, também deverá especificar o parâmetro NodeId.	dds-bpxxxxxxxx
NodeId	string	Não	O ID da instância do nó Mongos na instância de cluster fragmentado. Você pode especificar apenas um ID de nó Mongos em cada chamada.\n\n> Este parâmetro é válido apenas quando o parâmetro DBInstanceId está definido como o ID da instância de um cluster fragmentado.	s-bpxxxxxxxx
CurrentConnectionString	string	Não	O endpoint atual, que é o endpoint a ser modificado.	s-bpxxxxxxxx.mongodb.rds.aliyuncs.com
NewConnectionString	string	Não	O novo endpoint. O endpoint deve atender aos seguintes requisitos:\n- Deve começar com uma letra minúscula.\n- Deve terminar com uma letra minúscula ou um dígito.\n- Pode conter apenas letras minúsculas, dígitos e hifens (-).\n- Deve ter de 8 a 63 caracteres de comprimento.\n\n> Especifique apenas o prefixo do endpoint. A parte restante não pode ser modificada.	aliyuntest111
NewPort	integer	Não	A nova porta. Valores válidos: 1000 a 65535.\n> Este parâmetro está ativo apenas quando o parâmetro DBInstanceId está definido como o ID de uma instância de disco em nuvem.	3310
PortModifyOnly	boolean	Não	Especifica se apenas os números de porta devem ser modificados. Se você modificar apenas os números de porta, a modificação em lote é suportada.
NetworkType	string	Não	O tipo de rede da string de conexão quando apenas o número da porta é modificado.	vpc
ForceModifySuffix	boolean	Não

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	FF36A84C-0694-42D0-861D-C383E8E4FAAF
ModifiedConnectionString	string

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "FF36A84C-0694-42D0-861D-C383E8E4FAAF",
  "ModifiedConnectionString": ""
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	NewConnectionString.NotSupport	Specified newConnectionString is not supported.	O formato de newConnectionString é inválido.
400	InvalidConnectionStringOrPort.Duplicate	Specified connection string or port already exists.	A string de conexão ou porta especificada já existe. Verifique e reenvie.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.