Todos os produtos
Search

Este produto

    Data Management:AddInstance

    Central de documentação

    Data Management:AddInstance

    Última atualização: Jul 22, 2026

    Registra uma instância de banco de dados no Data Management Service (DMS) e ativa a hospedagem segura para a instância.

    Descrição da operação

    Sua função do sistema deve ser DBA ou administrador. Para visualizar sua função do sistema, consulte Visualizar minha função do sistema.

    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

    dms:AddInstance

    create

    *All Resource

    *

    		 Nenhuma Nenhuma

    Parâmetros da solicitação

    Parâmetro

    Tipo

    Obrigatório

    Descrição

    Exemplo
    Tid

    integer

    Não

    O ID do locatário.

    Nota

    Você pode encontrar o ID do locatário passando o mouse sobre o ícone de perfil no canto superior direito do console do DMS.

    23****
    InstanceType

    string

    Sim

    O tipo de banco de dados. Para valores válidos, consulte Descrição do parâmetro DbType.

    MySQL.
    InstanceSource

    string

    Sim

    A origem da instância. Valores válidos:

    • PUBLIC_OWN: uma instância autogerenciada conectada pela Internet.

    • RDS: uma instância do ApsaraDB RDS.

    • ECS_OWN: uma instância autogerenciada em uma instância ECS.

    • VPC_IDC: uma instância autogerenciada em um IDC conectado por VPC.

    • GATEWAY: uma instância do Database Gateway.

    RDS.
    NetworkType

    string

    Sim

    O tipo de rede. Valores válidos:

    • CLASSIC: rede clássica.

    • VPC: rede VPC.

    VPC.
    EnvType

    string

    Sim

    O tipo de ambiente. Valores válidos:

    • product: ambiente de produção.

    • dev: ambiente de desenvolvimento.

    • pre: ambiente de pré-lançamento.

    • test: ambiente de teste.

    • sit: ambiente SIT.

    • uat: ambiente UAT.

    • pet: ambiente de teste de estresse.

    • stag: ambiente STAG.

    product.
    EcsInstanceId

    string

    Não

    O ID da instância. Por exemplo, se sua instância for uma instância do Database Gateway, insira o ID do gateway.

    Nota

    Este parâmetro é obrigatório se InstanceSource estiver definido como ECS_OWN ou GATEWAY.

    i-2zei9gs1t7h8l7ac****
    VpcId

    string

    Não

    O ID da instância da VPC.

    Nota

    Este parâmetro é obrigatório se InstanceSource estiver definido como VPC_IDC.

    vpc-2zef4o1hu7ljd****
    EcsRegion

    string

    Não

    A região onde a instância reside.

    Nota

    Este parâmetro é obrigatório se InstanceSource estiver definido como RDS, ECS_OWN, GATEWAY ou VPC_IDC.

    cn-hangzhou.
    Host

    string

    Sim

    O endereço de conexão do banco de dados.

    rm-bp1g3tf90******.sqlserver.rds.aliyuncs.com.
    Port

    integer

    Sim

    A porta de conexão do banco de dados.

    3306
    Sid

    string

    Não

    O SID da instância.

    Nota

    Este parâmetro é obrigatório se InstanceType estiver definido como ORACLE.

    testSid.
    DatabaseUser

    string

    Não

    A conta do banco de dados.

    testsdb.
    DatabasePassword

    string

    Não

    A senha do banco de dados.

    test***
    InstanceAlias

    string

    Sim

    O alias da instância, que ajuda você a identificar rapidamente a instância.

    Instância de teste.
    DbaId

    integer

    Sim

    O ID de usuário do DBA da instância. Você pode chamar a operação ListUsers ou GetInstance para obter esse valor.

    27****
    QueryTimeout

    integer

    Sim

    O período de tempo limite da consulta. Unidade: segundos.

    7200
    ExportTimeout

    integer

    Sim

    O período de tempo limite da exportação. Unidade: segundos.

    86400
    EnableSellTrust

    string

    Sim

    Especifica se a hospedagem segura deve ser ativada para a instância. Valores válidos:

    • Y: Ativa o modo de hospedagem segura.

    • N: Não ativa o modo de hospedagem segura.

    Y
    EnableSellStable

    string

    Não

    Especifica se o recurso de alteração estável deve ser ativado para a instância. Valores válidos:

    • Y: Ativar.

    • N: Não ativar.

    N
    EnableSellCommon

    string

    Não

    Especifica se o recurso de colaboração segura deve ser ativado para a instância. Valores válidos:

    • Y: Ativar.

    • N: Não ativar.

    Y
    SafeRule

    string

    Não

    Se você deseja ativar o recurso de colaboração segura, deve especificar o conjunto de regras de segurança (GroupName) para a instância. Você pode chamar a operação ListStandardGroups ou GetInstance para obter esse valor.

    Finance-Production.
    EnableSellSitd

    string

    Não

    Especifica se o recurso de proteção de dados sensíveis deve ser ativado para a instância. Valores válidos:

    • Y: Ativar.

    • N: Não ativar.

    Y
    DataLinkName

    string

    Não

    O nome do datalink de consulta entre bancos de dados.

    Nota

    • Este parâmetro é obrigatório se UseDsql estiver definido como 1.

    • O nome do DBLink pode conter apenas letras minúsculas e sublinhados (_).

    • O nome do DBLink deve ser globalmente exclusivo dentro do locatário.

    dblink_test.
    DdlOnline

    integer

    Não

    Especifica se a alteração de estrutura do DMS tem prioridade. Valores válidos:

    • 0: Não usar.

    • 1: Online DDL nativo tem prioridade.

    • 2: Alteração de estrutura sem bloqueio do DMS tem prioridade.

    Nota

    Tipos de banco de dados suportados: ApsaraDB RDS for MySQL, PolarDB for MySQL, MyBase for MySQL e outras fontes MySQL.

    2
    UseDsql

    integer

    Não

    Especifica se a consulta entre instâncias deve ser ativada. Valores válidos:

    • 0: Desativar.

    • 1: Ativar.

    Nota

    Tipos de banco de dados suportados: MySQL, SQL Server, PostgreSQL, PolarDB for PostgreSQL (compatível com Oracle) e Redis.

    1
    SkipTest

    boolean

    Não

    Especifica se o teste de conectividade da instância deve ser ignorado. Valores válidos:

    • true: Ignorar.

    • false: Não ignorar.

    false.
    TemplateId

    integer

    Não

    O ID do modelo de classificação de dados. Você pode chamar a operação ListClassificationTemplates para obter esse valor.

    31***
    TemplateType

    string

    Não

    O tipo de modelo de categorização. Você pode chamar a operação ListClassificationTemplates para obter esse valor.

    INNER.
    UseSsl

    integer

    Não

    Especifica se a conexão SSL deve ser ativada. Após a ativação do SSL, o DMS conecta-se ao banco de dados via SSL. O banco de dados deve ter o SSL ativado antes de você usar este parâmetro. Valores válidos:

    • 0: Valor padrão (o DMS e o serviço de banco de dados negociam automaticamente se o SSL deve ser ativado). O sistema identifica automaticamente se o banco de dados de destino tem o SSL ativado. Se o SSL estiver ativado, o DMS conecta-se ao banco de dados via SSL. Caso contrário, o DMS conecta-se por meio de um método regular.

    • 1: Ativar conexão SSL. Se o banco de dados não tiver o SSL ativado, este parâmetro não terá efeito.

    • -1: Desativar conexão SSL.

    Nota

    • Este item de configuração está disponível apenas quando o tipo de banco de dados é MySQL ou Redis.

    • O SSL (Secure Sockets Layer) criptografa as conexões de rede na camada de transporte, melhorando a segurança e a integridade dos dados de comunicação, mas aumenta o tempo de resposta da conexão de rede.

    0
    RoleArn

    string

    Não

    O ARN da função autorizada na conta de destino, usado para registro entre locatários.

    acs:ram::1760865*********:role/dms-role-arn.
    LoginType

    integer

    Não

    • 0: Login com nome de usuário e senha.

    • 1: Apenas senha (Redis).

    • 2: Login sem senha (Redis).

    0

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    RequestId

    string

    O ID da solicitação. Você pode usar este ID para localizar logs e solucionar problemas.

    0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
    ErrorCode

    string

    O código de erro.

    UnknownError.
    ErrorMessage

    string

    A mensagem de erro.

    UnknownError.
    Success

    boolean

    Indica se a solicitação foi bem-sucedida. Valores válidos:

    • true: A solicitação foi bem-sucedida.

    • false: A solicitação falhou.

    true.

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

    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.