TestDataSourceConnectivity - DataWorks: Central de Documentação do Alibaba Cloud

Testa a conectividade de uma fonte de dados em um grupo de recursos.

Descrição da operação

Você deve adquirir o DataWorks Basic Edition ou uma edição superior para usar este recurso.
Você deve ter pelo menos uma das seguintes funções no workspace do DataWorks:<br> Proprietário do tenant, Administrador do workspace, Deployer, Desenvolvedor, Proprietário do projeto ou Operador.

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

dataworks:TestDataSourceConnectivity

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ResourceGroupId	string	Sim	O ID do grupo de recursos.	Serverless_res_group_524257424564736_6831777003XXXXX
DataSourceId	integer	Sim	O ID da fonte de dados para a qual você deseja testar a conectividade de rede.	144544
ProjectId	integer	Sim	O ID do workspace do DataWorks.	10001

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação.	4CDF7B72-020B-542A-8465-21CFFA81****
Connectivity	object	Os detalhes do teste de conectividade.
ConnectState	string	O resultado do teste de conectividade. Valores válidos: Connectable: A rede pode ser conectada. ConfigError: A rede pode ser conectada, mas as configurações estão incorretas. Unreachable: A rede não pode ser conectada. Unsupport: O cenário não é suportado. Por exemplo, o grupo de recursos desejado está sendo inicializado.	Connectable
ConnectMessage	string	A mensagem de erro retornada se o teste de conectividade falhar. Nenhuma mensagem desse tipo é retornada se o teste de conectividade for bem-sucedido.	Failed to connect to the database.
DetailLogs	array<object>	Os logs detalhados de cada etapa no teste de conectividade.
	object
StartTime	integer	A hora de início de uma etapa.	1730217600001
EndTime	integer	A hora de término de uma etapa.	1730217604002
Code	string	O código do item de teste.	validate_input_parameters
Message	string	O nome da etapa.	Validate input parameters

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "4CDF7B72-020B-542A-8465-21CFFA81****",
  "Connectivity": {
    "ConnectState": "Connectable",
    "ConnectMessage": "连接数据库失败",
    "DetailLogs": [
      {
        "StartTime": 1730217600001,
        "EndTime": 1730217604002,
        "Code": "validate_input_parameters",
        "Message": "校验输入参数"
      }
    ]
  }
}

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.